Skip to content
Snippets Groups Projects
Commit e7e2ff7c authored by Ladislav Lhotka's avatar Ladislav Lhotka
Browse files

Add documentation for typealiases module.

parent b5c755c7
No related branches found
No related tags found
No related merge requests found
......@@ -7,6 +7,7 @@ Contents:
:maxdepth: 2
instances
typealiases
references
Indices and tables
......
============
Type Aliases
============
.. module:: yangson.typealiases
:synopsis: Type aliases
.. moduleauthor:: Ladislav Lhotka <lhotka@nic.cz>
We define several type aliases shown in the following table to give more meaning to type hints [PEP484].
+----------------+--------------------------------------------------------------+--------+
| Alias | Type | Remark |
+================+==============================================================+========+
| Uri | :class:`str` | (1) |
+----------------+--------------------------------------------------------------+--------+
| YangIdentifier | :class:`str` | (2) |
+----------------+--------------------------------------------------------------+--------+
| RevisionDate | ``Optional[``:class:`str```]`` | (3) |
+----------------+--------------------------------------------------------------+--------+
| Value | Union[:class:`int`, :class:`str`, :class:`decimal.Decimal`, | |
| | List["Value"], Dict[QName, "Value"]] | |
+----------------+--------------------------------------------------------------+--------+
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment