sslutil: expand _defaultcacerts docstring to note calling assumptions
authorGregory Szorc <gregory.szorc@gmail.com>
Thu, 30 Jun 2016 19:54:12 -0700
changeset 29488 1c26b9ce66f8
parent 29487 cdcb5747dc88
child 29489 54ad81b0665f
sslutil: expand _defaultcacerts docstring to note calling assumptions We should document this so future message additions don't seem out of place.
mercurial/sslutil.py
--- a/mercurial/sslutil.py	Mon Jul 04 10:00:56 2016 -0700
+++ b/mercurial/sslutil.py	Thu Jun 30 19:54:12 2016 -0700
@@ -431,7 +431,12 @@
             exe.startswith('/system/library/frameworks/python.framework/'))
 
 def _defaultcacerts(ui):
-    """return path to default CA certificates or None."""
+    """return path to default CA certificates or None.
+
+    It is assumed this function is called when the returned certificates
+    file will actually be used to validate connections. Therefore this
+    function may print warnings or debug messages assuming this usage.
+    """
     # The "certifi" Python package provides certificates. If it is installed,
     # assume the user intends it to be used and use it.
     try: