8000 gh-101100: Fix Sphinx warnings in `library/pyclbr.rst` by hugovk · Pull Request #113739 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-101100: Fix Sphinx warnings in library/pyclbr.rst #113739

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 5 commits into from
Jan 5, 2024
Merged

gh-101100: Fix Sphinx warnings in library/pyclbr.rst #113739

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8daddd9
Fix Sphinx warnings in library/pyclbr.rst
hugovk Jan 5, 2024
b88f0e1
Indent attributes inside classes
hugovk Jan 5, 2024
4308235
Fix readline/readline_ex -> readmodule/readmodule_ex typos
hugovk Jan 5, 2024
5690924
Don't refer to target inside target
hugovk Jan 5, 2024
a7ceb1e
Apply suggestions from code review
hugovk Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading 8000
Diff view
Diff view
Prev Previous commit
Next Next commit
Indent attributes inside classes
  • Loading branch information
@hugovk
hugovk committed Jan 5, 2024
commit b88f0e10224b2136b7ad34193f70dec226c76eb2
94 changes: 47 additions & 47 deletions Doc/library/pyclbr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,50 +61,50 @@ Function Objects

.. class:: Function

Class :class:`Function` instances describe functions defined by def
statements. They have the following attributes:
Class :class:`Function` instances describe functions defined by def
statements. They have the following attributes:


.. attribute:: Function.file
.. attribute:: file

Name of the file in which the function is defined.
Name of the file in which the function is defined.


.. attribute:: Function.module
.. attribute:: module

The name of the module defining the function described.
The name of the module defining the function described.


.. attribute:: Function.name
.. attribute:: name

The name of the function.
The name of the function.


.. attribute:: Function.lineno
.. attribute:: lineno

The line number in the file where the definition starts.
The line number in the file where the definition starts.


.. attribute:: Function.parent
.. attribute:: parent

For top-level functions, None. For nested functions, the parent.
For top-level functions, None. For nested functions, the parent.

.. versionadded:: 3.7
.. versionadded:: 3.7


.. attribute:: Function.children
.. attribute:: children

A dictionary mapping names to descriptors for nested functions and
classes.
A dictionary mapping names to descriptors for nested functions and
classes.

.. versionadded:: 3.7
.. versionadded:: 3.7


.. attribute:: Function.is_async
.. attribute:: is_async

``True`` for functions that are defined with the ``async`` prefix, ``False`` otherwise.
``True`` for functions that are defined with the ``async`` prefix, ``False`` otherwise.

.. versionadded:: 3.10
.. versionadded:: 3.10


.. _pyclbr-class-objects:
Expand All @@ -114,56 +114,56 @@ Class Objects

.. class:: Class

Class :class:`Class` instances describe classes defined by class
statements. They have the same attributes as Functions and two more.
Class :class:`Class` instances describe classes defined by class
statements. They have the same attributes as Functions and two more.


.. attribute:: Class.file
.. attribute:: file

Name of the file in which the class is defined.
Name of the file in which the class is defined.


.. attribute:: Class.module
.. attribute:: module

The name of the module defining the class described.
The name of the module defining the class described.


.. attribute:: Class.name
.. attribute:: name

The name of the class.
The name of the class.


.. attribute:: Class.lineno
.. attribute:: lineno

The line number in the file where the definition starts.
The line number in the file where the definition starts.


.. attribute:: Class.parent
.. attribute:: parent

For top-level classes, None. For nested classes, the parent.
For top-level classes, None. For nested classes, the parent.

.. versionadded:: 3.7
.. versionadded:: 3.7


.. attribute:: Class.children
.. attribute:: children

A dictionary mapping names to descriptors for nested functions and
classes.
A dictionary mapping names to descriptors for nested functions and
classes.

.. versionadded:: 3.7
.. versionadded:: 3.7


.. attribute:: Class.super
.. attribute:: super

A list of :class:`Class` objects which describe the immediate base
classes of the class being described. Classes which are named as
superclasses but which are not discoverable by :func:`readmodule_ex`
are listed as a string with the class name instead of as
:class:`Class` objects.
A list of :class:`Class` objects which describe the immediate base
classes of the class being described. Classes which are named as
superclasses but which are not discoverable by :func:`readmodule_ex`
are listed as a string with the class name instead of as
:class:`Class` objects.


.. attribute:: Class.methods
.. attribute:: methods

A dictionary mapping method names to line numbers. This can be
derived from the newer children dictionary, but remains for
back-compatibility.
A dictionary mapping method names to line numbers. This can be
derived from the newer children dictionary, but remains for
back-compatibility.
0