1616
1717--------------
1818
19- The :mod: `pydoc ` module automatically generates documentation from Python
19+ The :mod: `! pydoc ` module automatically generates documentation from Python
2020modules. The documentation can be presented as pages of text on the console,
2121served to a web browser, or saved to HTML files.
2222
2323For modules, classes, functions and methods, the displayed documentation is
24- derived from the docstring (i.e. the :attr: `__doc__ ` attribute) of the object,
24+ derived from the docstring (i.e. the :attr: `! __doc__ ` attribute) of the object,
2525and recursively of its documentable members. If there is no docstring,
26- :mod: `pydoc ` tries to obtain a description from the block of comment lines just
26+ :mod: `! pydoc ` tries to obtain a description from the block of comment lines just
2727above the definition of the class, function or method in the source file, or at
2828the top of the module (see :func: `inspect.getcomments `).
2929
3030The built-in function :func: `help ` invokes the online help system in the
31- interactive interpreter, which uses :mod: `pydoc ` to generate its documentation
31+ interactive interpreter, which uses :mod: `! pydoc ` to generate its documentation
3232as text on the console. The same text documentation can also be viewed from
3333outside the Python interpreter by running :program: `pydoc ` as a script at the
3434operating system's command prompt. For example, running ::
@@ -46,7 +46,7 @@ produced for that file.
4646
4747.. note ::
4848
49- In order to find objects and their documentation, :mod: `pydoc ` imports the
49+ In order to find objects and their documentation, :mod: `! pydoc ` imports the
5050 module(s) to be documented. Therefore, any code on module level will be
5151 executed on that occasion. Use an ``if __name__ == '__main__': `` guard to
5252 only execute code when a file is invoked as a script and not just imported.
@@ -90,7 +90,7 @@ Python interpreter and typed ``import spam``.
9090Module docs for core modules are assumed to reside in
9191``https://docs.python.org/X.Y/library/ `` where ``X `` and ``Y `` are the
9292major and minor version numbers of the Python interpreter. This can
93- be overridden by setting the :envvar: `PYTHONDOCS ` environment variable
93+ be overridden by setting the :envvar: `! PYTHONDOCS ` environment variable
9494to a different URL or to a local directory containing the Library
9595Reference Manual pages.
9696
@@ -101,7 +101,7 @@ Reference Manual pages.
101101 The ``-g `` command line option was removed.
102102
103103.. versionchanged :: 3.4
104- :mod: `pydoc ` now uses :func: `inspect.signature ` rather than
104+ :mod: `! pydoc ` now uses :func: `inspect.signature ` rather than
105105 :func: `inspect.getfullargspec ` to extract signature information from
106106 callables.
107107
0 commit comments