diff options
| author | Jason Madden <jamadden@gmail.com> | 2018-09-27 07:17:41 -0500 |
|---|---|---|
| committer | Jason Madden <jamadden@gmail.com> | 2018-09-27 07:17:41 -0500 |
| commit | 6114a6022d76b046781ee0434434e696664b84c1 (patch) | |
| tree | 7772e91cd8cb982dbbb11dda860b47ea6a1ea267 | |
| parent | de407e5f4beb88d9aeedebec6469ab44d88324ac (diff) | |
| download | zope-configuration-6114a6022d76b046781ee0434434e696664b84c1.tar.gz | |
Unify docs for name.rst/py back into .py. Note that the functions never had any actual documentation and are not used here, so leave a warning that they might get deprecated.
| -rw-r--r-- | docs/api/name.rst | 13 | ||||
| -rw-r--r-- | src/zope/configuration/name.py | 6 |
2 files changed, 9 insertions, 10 deletions
diff --git a/docs/api/name.rst b/docs/api/name.rst index 69a3f56..4471308 100644 --- a/docs/api/name.rst +++ b/docs/api/name.rst @@ -1,10 +1,5 @@ -:mod:`zope.configuration.name` -============================== +========================= + zope.configuration.name +========================= -.. module:: zope.configuration.name - -.. autofunction:: resolve - -.. autofunction:: getNormalizedName - -.. autofunction:: path +.. automodule:: zope.configuration.name diff --git a/src/zope/configuration/name.py b/src/zope/configuration/name.py index a162ea1..97b7d76 100644 --- a/src/zope/configuration/name.py +++ b/src/zope/configuration/name.py @@ -11,7 +11,11 @@ # FOR A PARTICULAR PURPOSE. # ############################################################################## -"""Provide configuration object name resolution +""" +Provide configuration object name resolution. + +.. note:: This module is no longer used by `zope.configuration` and + may be deprecated soon. Its functions are not documented. """ import os |