Browse Source

Documentation fixes.

pull/60/head
Rapptz 9 years ago
parent
commit
78e95ef755
  1. 6
      discord/client.py
  2. 4
      discord/voice_client.py

6
discord/client.py

@ -1331,12 +1331,12 @@ class Client:
The game_id parameter is a numeric ID (not a string) that represents
a game being played currently. The list of game_id to actual games changes
constantly and would thus be out of date pretty quickly. An old version of
the game_id database can be seen `here`_ to help you get started.
the game_id database can be seen `here <game_list>`_ to help you get started.
The idle parameter is a boolean parameter that indicates whether the
client should go idle or not.
.. _here: https://gist.github.com/Rapptz/a82b82381b70a60c281b
.. _game_list: https://gist.github.com/Rapptz/a82b82381b70a60c281b
Parameters
----------
@ -1636,7 +1636,7 @@ class Client:
def get_bans(self, server):
"""|coro|
Retrieves all the :class:`User`s that are banned from the specified
Retrieves all the :class:`User` s that are banned from the specified
server.
You must have proper permissions to get this information.

4
discord/voice_client.py

@ -416,7 +416,7 @@ class VoiceClient:
The operations that can be done on the player are the same as those in
:meth:`create_stream_player`.
.. _here: https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L117-L265
.. _ytdl: https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L117-L265
Examples
----------
@ -434,7 +434,7 @@ class VoiceClient:
to ``ffmpeg`` or ``avconv`` to convert to PCM bytes.
options : dict
A dictionary of options to pass into the ``YoutubeDL`` instance.
See `here`_ for more details.
See `the documentation <ydl>`_ for more details.
use_avconv: bool
Use ``avconv`` instead of ``ffmpeg``. Passes the appropriate
flags to ``youtube-dl`` as well.

Loading…
Cancel
Save