diff options
| author | Rapptz <[email protected]> | 2015-12-09 19:56:41 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2015-12-09 19:56:41 -0500 |
| commit | 5335f468d2723a4303131d0fa6287c0cef207440 (patch) | |
| tree | 89dd4021a8e3e1f3da5aa1392fca792cc23bf02f /docs | |
| parent | Add discord.version_info (diff) | |
| download | discord.py-5335f468d2723a4303131d0fa6287c0cef207440.tar.xz discord.py-5335f468d2723a4303131d0fa6287c0cef207440.zip | |
Document discord.__version__ and discord.version_info
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index 68f814d1..7971edff 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,6 +13,24 @@ The following section outlines the API of discord.py. more information on how to set up and use the logging module with discord.py. +Version Related Info +--------------------- + +There are two main ways to query version information about the library. + +.. data:: version_info + + A named tuple that is similar to `sys.version_info`_. + + Just like `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'``. + Client ------- |