Skip to content

Commit 1bb07d4

Browse files
author
kuyan
committed
Added pydoc section
1 parent f99e5c5 commit 1bb07d4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/intro/documentation.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,21 @@ both popular and exotic.
2020
`Read the Docs <https://readthedocs.org/>`_
2121

2222

23+
pydoc
24+
-----
25+
26+
:program:`pydoc` is a utlity that is installed when you install Python.
27+
It allows you to quickly retrieve and search for documentation from your
28+
shell. For example, if you needed a quick refresher on the
29+
:mod:`time` module, pulling up documentation would be as simple as
30+
31+
.. code-block:: bash
32+
33+
$ pydoc time
34+
35+
The above command is essentially equivalent to opening the Python REPL
36+
and running
37+
38+
.. code-block:: python
39+
40+
>>> help(time)

0 commit comments

Comments
 (0)