diff options
| author | NCPlayz <[email protected]> | 2019-03-16 21:43:55 +0000 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2019-03-19 08:24:42 -0400 |
| commit | fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa (patch) | |
| tree | 7a0a5c9aaa5cc5bac26fc51caf4fdffbaee64c26 /discord/opus.py | |
| parent | Take back ownership of files from aiohttp for retrying requests. (diff) | |
| download | discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.tar.xz discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.zip | |
Organise documentation
Diffstat (limited to 'discord/opus.py')
| -rw-r--r-- | discord/opus.py | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/discord/opus.py b/discord/opus.py index f62fa0b1..334840e6 100644 --- a/discord/opus.py +++ b/discord/opus.py @@ -125,23 +125,23 @@ def load_opus(name): This function propagates the exceptions thrown. - Warning - -------- - The bitness of the library must match the bitness of your python - interpreter. If the library is 64-bit then your python interpreter - must be 64-bit as well. Usually if there's a mismatch in bitness then - the load will throw an exception. - - Note - ---- - On Windows, the .dll extension is not necessary. However, on Linux - the full extension is required to load the library, e.g. ``libopus.so.1``. - On Linux however, `find library`_ will usually find the library automatically - without you having to call this. + .. warning:: + + The bitness of the library must match the bitness of your python + interpreter. If the library is 64-bit then your python interpreter + must be 64-bit as well. Usually if there's a mismatch in bitness then + the load will throw an exception. + + .. note:: + + On Windows, the .dll extension is not necessary. However, on Linux + the full extension is required to load the library, e.g. ``libopus.so.1``. + On Linux however, `find library`_ will usually find the library automatically + without you having to call this. Parameters ---------- - name: str + name: :class:`str` The filename of the shared library. """ global _lib @@ -155,7 +155,7 @@ def is_loaded(): Returns ------- - bool + :class:`bool` Indicates if the opus library has been loaded. """ global _lib @@ -166,7 +166,7 @@ class OpusError(DiscordException): Attributes ---------- - code : :class:`int` + code: :class:`int` The error code returned. """ |