Skip to content

fix(docs): qualify the ambiguous Type refs in the foundation rst tree #714

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
JarryShaw merged 1 commit into from
Sep 23, 2026
Merged

fix(docs): qualify the ambiguous Type refs in the foundation rst tree #714

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/source/pcapkit/foundation/engines/engine.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ all engine support functionality.
value can be set by :attr:`__engine_module__` class attribute.

.. property:: registry
:type: dict[str, ModuleDescriptor[EngineBase] | Type[EngineBase]]
:type: dict[str, ModuleDescriptor[EngineBase] | typing.Type[EngineBase]]

Mapping of engine names to engine classes.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/pcapkit/foundation/reassembly/reassembly.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ implements datagram reassembly of IP and TCP packets.


.. property:: protocol
:type: Type[Protocol]
:type: typing.Type[Protocol]

Protocol of current reassembly class.

Expand All @@ -40,7 +40,7 @@ implements datagram reassembly of IP and TCP packets.
value can be set by :attr:`__protocol_type__` class attribute.

.. property:: registry
:type: dict[str, ModuleDescriptor[ReassemblyBase] | Type[ReassemblyBase]]
:type: dict[str, ModuleDescriptor[ReassemblyBase] | typing.Type[ReassemblyBase]]

Mapping of protocol names to reassembly classes.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/pcapkit/foundation/traceflow/traceflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ which is an abstract base class for all flow tracing classes.
value can be set by :attr:`__protocol_type__` class attribute.

.. property:: registry
:type: dict[str, ModuleDescriptor[TraceFlowBase] | Type[TraceFlowBase]]
:type: dict[str, ModuleDescriptor[TraceFlowBase] | typing.Type[TraceFlowBase]]

Mapping of protocol names to flow tracing classes.

Expand Down
Loading