Skip to content

gh-64019: Have attribute table in inspect docs link to module attributes instead of listing them #98116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 25, 2022
Merged

gh-64019: Have attribute table in inspect docs link to module attributes instead of listing them #98116

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd9032b
Updated documentation for inspect module: some module attributes were…
MichaelAnckaert Aug 14, 2019
a93e855
Add box on __spec__
slateny Oct 9, 2022
0bf5d33
Add note about deprecation of module attributes
slateny Oct 12, 2022
17b50b3
Remove module table, add link to reference
slateny Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions Doc/library/inspect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,14 @@ The :func:`getmembers` function retrieves the members of an object such as a
class or module. The functions whose names begin with "is" are mainly
provided as convenient choices for the second argument to :func:`getmembers`.
They also help you determine when you can expect to find the following special
attributes:
attributes (see :ref:`import-mod-attrs` for module attributes):

.. this function name is too big to fit in the ascii-art table below
.. |coroutine-origin-link| replace:: :func:`sys.set_coroutine_origin_tracking_depth`

+-----------+-------------------+---------------------------+
| Type | Attribute | Description |
+===========+===================+===========================+
| module | __doc__ | documentation string |
+-----------+-------------------+---------------------------+
| | __file__ | filename (missing for |
| | | built-in modules) |
+-----------+-------------------+---------------------------+
| class | __doc__ | documentation string |
+-----------+-------------------+---------------------------+
| | __name__ | name with which this |
Expand Down