Skip to content

Commit 4d4123b

Browse files
committed
Reference 'Python' instead of 'Python 3'
1 parent 9a8eeac commit 4d4123b

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

doc/man/sphinx-apidoc.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,13 @@ Options
103103

104104
.. option:: --implicit-namespaces
105105

106-
By default sphinx-apidoc processes sys.path searching for modules only.
107-
Python 3.3 introduced :pep:`420` implicit namespaces that allow module path
108-
structures such as ``foo/bar/module.py`` or ``foo/bar/baz/__init__.py``
109-
(notice that ``bar`` and ``foo`` are namespaces, not modules).
106+
Without this option, :program:`sphinx-apidoc` searches :data:`sys.path`
107+
for Python packages containing :file:`__init__.py` files,
108+
or single-file Python modules.
110109

111-
Interpret paths recursively according to PEP-0420.
110+
This option instead uses :pep:`420` implicit namespaces that allow
111+
layouts paths such as ``foo/bar/module.py`` or ``foo/bar/baz/__init__.py``
112+
(note that ``bar`` and ``foo`` are namespaces, not modules).
112113

113114
.. option:: -M, --module-first
114115

doc/usage/extensions/intersphinx.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,12 @@ Showing all links of an Intersphinx mapping file
220220
------------------------------------------------
221221

222222
To show all Intersphinx links and their targets of an Intersphinx mapping file,
223-
run ``python -msphinx.ext.intersphinx url-or-path``. This is helpful when
223+
run ``python -m sphinx.ext.intersphinx url-or-path``. This is helpful when
224224
searching for the root cause of a broken Intersphinx link in a documentation
225-
project. The following example prints the Intersphinx mapping of the Python 3
226-
documentation::
225+
project.
226+
The following example prints the Intersphinx mapping of the Python documentation:
227+
228+
.. code-block:: console
227229
228230
$ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv
229231

doc/usage/extensions/napoleon.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ type checkers and IDEs can take advantage of them for static code
212212
analysis. :pep:`484` was then extended by :pep:`526` which introduced
213213
a similar way to annotate variables (and attributes).
214214

215-
Google style with Python 3 type annotations:
215+
Google style with type annotations:
216216

217217
.. code-block:: python
218218

0 commit comments

Comments
 (0)