-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs/api: Adds section about type aliases and not so public interfaces
It was motivated to create targets for then hyperlinking type annotations in the API docs. Turns out the second part doesn't work yet. I assume that better practices around type documentation will evolve. And it's still a usable reference that ranks high in searches.
- Loading branch information
1 parent
3cab654
commit c57aef7
Showing
6 changed files
with
54 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,5 +11,6 @@ API Documentation | |
querying | ||
transformations | ||
utilities | ||
typing | ||
exceptions | ||
extending |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
:tocdepth: 2 | ||
|
||
Type aliases & semi-public classes | ||
================================== | ||
|
||
There are internally used classes and type aliases that can be of interest for | ||
re-use in applications and extensions. | ||
|
||
Filter functions are defined as: | ||
|
||
.. autoclass:: delb.typing.Filter | ||
|
||
Loaders are defined as: | ||
|
||
.. autoclass:: delb.typing.Loader | ||
|
||
The order of loaders is defined with help of (read: | ||
``Loader | Iterable[Loader] | None``): | ||
|
||
.. autoclass:: delb.typing.LoaderConstraint | ||
|
||
Loaders may return a string that explains why it wouldn't successfully process | ||
the given input to the user: | ||
|
||
.. autoclass:: delb.typing.LoaderResult | ||
|
||
Namespace to prefix mappings are formalized as: | ||
|
||
.. autoclass:: delb.typing.NamespaceDeclarations | ||
|
||
All node classes inherit from a common class: | ||
|
||
.. class:: delb.NodeBase | ||
|
||
Methods that add nodes to a tree take a variety of input data: | ||
|
||
.. autoclass:: delb.typing.NodeSource | ||
|
||
Definitions that are used for convenient tree building are held in: | ||
|
||
.. autoclass:: _delb.nodes._TagDefinition |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters