# HG changeset patch # User Franz Glasner # Date 1557074832 -7200 # Node ID c8d071581a4c068d9d605863e2ce47bc72fe1cc2 # Parent bbe8513ea649b33f1838406ae899362c8780a42d Doc: adjust documentation of configmix.compat slightly diff -r bbe8513ea649 -r c8d071581a4c configmix/compat.py --- 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 diff -r bbe8513ea649 -r c8d071581a4c doc/apidoc.rst --- 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`