mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-04-19 15:36:02 +00:00
Documentation fixes for opus related import errors.
This commit is contained in:
parent
72f355bb64
commit
9bec041423
@ -80,10 +80,11 @@ def load_opus(name):
|
||||
"""Loads the libopus shared library for use with voice.
|
||||
|
||||
If this function is not called then the library uses the function
|
||||
`ctypes.util.find_library <find_library>` and then loads that one
|
||||
`ctypes.util.find_library`__ and then loads that one
|
||||
if available.
|
||||
|
||||
.. find_library: https://docs.python.org/3.5/library/ctypes.html#finding-shared-libraries
|
||||
.. _find library: https://docs.python.org/3.5/library/ctypes.html#finding-shared-libraries
|
||||
__ `find library`_
|
||||
|
||||
Not loading a library leads to voice not working.
|
||||
|
||||
@ -100,7 +101,7 @@ def load_opus(name):
|
||||
----
|
||||
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
|
||||
On Linux however, `find library`_ will usually find the library automatically
|
||||
without you having to call this.
|
||||
|
||||
Parameters
|
||||
|
10
docs/api.rst
10
docs/api.rst
@ -31,14 +31,14 @@ Voice
|
||||
Opus Library
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. autofunction:: opus.load_opus
|
||||
.. autofunction:: discord.opus.load_opus
|
||||
|
||||
.. autofunction:: opus.is_loaded
|
||||
.. autofunction:: discord.opus.is_loaded
|
||||
|
||||
.. _discord-api-events:
|
||||
|
||||
Event Reference
|
||||
~~~~~~~~~~~~~~~~
|
||||
---------------
|
||||
|
||||
This page outlines the different types of events listened by :class:`Client`.
|
||||
|
||||
@ -459,6 +459,6 @@ The following exceptions are thrown by the library.
|
||||
|
||||
.. autoexception:: GatewayNotFound
|
||||
|
||||
.. autoexception:: opus.OpusError
|
||||
.. autoexception:: discord.opus.OpusError
|
||||
|
||||
.. autoexception:: opus.OpusNotLoaded
|
||||
.. autoexception:: discord.opus.OpusNotLoaded
|
||||
|
Loading…
x
Reference in New Issue
Block a user