Eunchong Yu avatar Eunchong Yu committed c849ec9

Polish some sentence

Comments (0)

Files changed (1)


       will exclude :func:`admin`, :func:`admin_login` view functions.
-      .. warning::
+      .. note::
-         Unlike the `undoc-members`_ flag of the
-         :mod:`~sphinx.ext.autodoc` extension, the ``undoc-endpoints``
-         didn't includes view functions without docstrings. It has an opposite
-         effect to ``undoc-members`` so it could be confusing.
+         While the `undoc-members`_ flag of :mod:`sphinx.ext.autodoc` extension
+         includes members without docstrings, ``undoc-endpoints`` option has
+         nothing to do with docstrings. It just excludes specified endpoints.
          .. _undoc-members:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.