diff options
| author | Rapptz <[email protected]> | 2019-04-08 01:10:14 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2019-04-08 02:18:48 -0400 |
| commit | 1243298b34ba68e5f7b5a2ccb1c0520a360f1f9b (patch) | |
| tree | d1b4b7ef70d9b4a90f15b2720ec80767f4232b0b /docs/api.rst | |
| parent | terminate iterators immediately once out of data (diff) | |
| download | discord.py-1243298b34ba68e5f7b5a2ccb1c0520a360f1f9b.tar.xz discord.py-1243298b34ba68e5f7b5a2ccb1c0520a360f1f9b.zip | |
Add some version guarantees to the documentation.
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/api.rst b/docs/api.rst index 9208dafd..7371537d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -16,20 +16,19 @@ The following section outlines the API of discord.py. Version Related Info --------------------- -There are two main ways to query version information about the library. +There are two main ways to query version information about the library. For guarantees, check :ref:`version_guarantees`. .. data:: version_info - A named tuple that is similar to `sys.version_info`_. + A named tuple that is similar to :obj:`py:sys.version_info`. - Just like `sys.version_info`_ the valid values for ``releaselevel`` are + Just like :obj:`py:sys.version_info`_ the valid values for ``releaselevel`` are 'alpha', 'beta', 'candidate' and 'final'. - .. _sys.version_info: https://docs.python.org/3.5/library/sys.html#sys.version_info - .. data:: __version__ - A string representation of the version. e.g. ``'0.10.0-alpha0'``. + A string representation of the version. e.g. ``'1.0.0rc1'``. This is based + off of `PEP-440 <https://www.python.org/dev/peps/pep-0440/>`_. Client ------- |