Mercurial > hgrepos > Python > libs > ConfigMix

changeset 714:465bac57b97e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: Docs for configmix.config: use more manual docs. This is also to document more closely the pure-Python implementation, the C-API implementation and their aliases.
author Franz Glasner <f.glasner@feldmann-mg.com>
date Tue, 15 Aug 2023 17:14:21 +0200
parents 1832c5d1bd00
children 0c73d95ec454
files docs/apidoc.rst
diffstat 1 files changed, 21 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/docs/apidoc.rst	Tue Aug 15 17:10:57 2023 +0200
+++ b/docs/apidoc.rst	Tue Aug 15 17:14:21 2023 +0200
@@ -26,14 +26,32 @@
 ------------------------------
 
 .. automodule:: configmix.config
-   :members:
    :ignore-module-all:
-   :private-members: _JailedConfiguration
+
+   .. autoclass:: Configuration
+      :members:
+      :undoc-members:
+      :special-members: __getitem__, __getattr__, __contains__
+
+   .. autoclass:: CoercingMethodsMixin
+      :members:
+      :undoc-members:
+
+   While not instantiable directly, but only by
+   :meth:`Configuration.jailed`, the API use will want to know its interface:
 
    .. autoclass:: _JailedConfiguration
       :members:
       :undoc-members:
-      :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__
+      :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__
+
+   Some public helper functions:
+
+   .. autofunction:: py_quote
+
+   .. autofunction:: py_unquote
+
+   .. autofunction:: py_pathstr2path
 
 
 Module :mod:`configmix.constants`