Mercurial > hgrepos > Python > libs > ConfigMix

changeset 209:c8d071581a4c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc: adjust documentation of configmix.compat slightly
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 05 May 2019 18:47:12 +0200
parents bbe8513ea649
children fa660f084ceb
files configmix/compat.py doc/apidoc.rst
diffstat 2 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/configmix/compat.py	Sun May 05 18:40:03 2019 +0200
+++ b/configmix/compat.py	Sun May 05 18:47:12 2019 +0200
@@ -52,6 +52,9 @@
     def u2fs(s, force=False):
         """Convert a text (Unicode) string to the filesystem encoding.
 
+        .. note:: The filesystem encoding on Python 3 is a Unicode text
+                  string. The function is a noop when called on Python 3.
+
         .. note:: If `s` is already a byte string be permissive and
                   return `s` unchanged.
 
@@ -86,6 +89,9 @@
         .. note:: The filesystem encoding on Python 3 is a Unicode text
                   string. The function is a noop when called on Python 3.
 
+        .. note:: If `s` is already a byte string be permissive and
+                  return `s` unchanged.
+
         """
         assert isinstance(s, str)
         return s
--- a/doc/apidoc.rst	Sun May 05 18:40:03 2019 +0200
+++ b/doc/apidoc.rst	Sun May 05 18:47:12 2019 +0200
@@ -19,7 +19,7 @@
 
 .. automodule:: configmix.compat
    :members:
-   :ignore-module-all:
+   :undoc-members:
 
 
 Module :mod:`configmix.config`