Skip to content

fix(docs): stop AppType shadowing six builtins in cross-references #724

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

Closed
JarryShaw wants to merge 1 commit into from
Closed

fix(docs): stop AppType shadowing six builtins in cross-references #724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions docs/source/pcapkit/const/reg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,19 @@ Application Layer Protocol Numbers
This module contains the constant enumeration for **Application Layer Protocol Numbers**,
which is automatically generated from :class:`pcapkit.vendor.reg.apptype.AppType`.

.. AppType has 8,182 members, six of which collide with builtins (dict, exec, help,
max, set, sum) and win bare ``:type:`` lookups project-wide (#717). The autoclass
below no-indexes itself and every member to kill those collisions; this stub keeps
:class:`AppType <pcapkit.const.reg.apptype.AppType>` itself a working xref target.

.. py:class:: AppType
:no-typesetting:

.. autoclass:: pcapkit.const.reg.apptype.AppType
:members:
:undoc-members:
:show-inheritance:
:no-index:

.. rubric:: Footnotes

Expand Down
Loading