mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-07-14 22:02:07 +00:00
Prefer code-block directive over :: in faq.rst
This commit is contained in:
parent
6901907b69
commit
2bfbd1a979
42
docs/faq.rst
42
docs/faq.rst
@ -192,7 +192,9 @@ If you want to use unicode emoji, you must pass a valid unicode code point in a
|
|||||||
- ``'\U0001F44D'``
|
- ``'\U0001F44D'``
|
||||||
- ``'\N{THUMBS UP SIGN}'``
|
- ``'\N{THUMBS UP SIGN}'``
|
||||||
|
|
||||||
Quick example: ::
|
Quick example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
emoji = '\N{THUMBS UP SIGN}'
|
emoji = '\N{THUMBS UP SIGN}'
|
||||||
# or '\U0001f44d' or '👍'
|
# or '\U0001f44d' or '👍'
|
||||||
@ -208,7 +210,9 @@ can use said emoji, you should be able to use :meth:`Client.get_emoji` to get an
|
|||||||
The name and ID of a custom emoji can be found with the client by prefixing ``:custom_emoji:`` with a backslash.
|
The name and ID of a custom emoji can be found with the client by prefixing ``:custom_emoji:`` with a backslash.
|
||||||
For example, sending the message ``\:python3:`` with the client will result in ``<:python3:232720527448342530>``.
|
For example, sending the message ``\:python3:`` with the client will result in ``<:python3:232720527448342530>``.
|
||||||
|
|
||||||
Quick example: ::
|
Quick example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
|
|
||||||
# if you have the ID already
|
# if you have the ID already
|
||||||
@ -237,7 +241,9 @@ us, :mod:`asyncio` comes with a :func:`asyncio.run_coroutine_threadsafe` functio
|
|||||||
a coroutine from another thread.
|
a coroutine from another thread.
|
||||||
|
|
||||||
However, this function returns a :class:`~concurrent.futures.Future` and to actually call it we have to fetch its result. Putting all of
|
However, this function returns a :class:`~concurrent.futures.Future` and to actually call it we have to fetch its result. Putting all of
|
||||||
this together we can do the following: ::
|
this together we can do the following:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
def my_after(error):
|
def my_after(error):
|
||||||
coro = some_channel.send('Song is done!')
|
coro = some_channel.send('Song is done!')
|
||||||
@ -283,7 +289,9 @@ The following use an HTTP request:
|
|||||||
If the functions above do not help you, then use of :func:`utils.find` or :func:`utils.get` would serve some use in finding
|
If the functions above do not help you, then use of :func:`utils.find` or :func:`utils.get` would serve some use in finding
|
||||||
specific models.
|
specific models.
|
||||||
|
|
||||||
Quick example: ::
|
Quick example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
# find a guild by name
|
# find a guild by name
|
||||||
guild = discord.utils.get(client.guilds, name='My Server')
|
guild = discord.utils.get(client.guilds, name='My Server')
|
||||||
@ -299,7 +307,9 @@ How do I make a web request?
|
|||||||
To make a request, you should use a non-blocking library.
|
To make a request, you should use a non-blocking library.
|
||||||
This library already uses and requires a 3rd party library for making requests, :doc:`aiohttp <aio:index>`.
|
This library already uses and requires a 3rd party library for making requests, :doc:`aiohttp <aio:index>`.
|
||||||
|
|
||||||
Quick example: ::
|
Quick example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
async with aiohttp.ClientSession() as session:
|
async with aiohttp.ClientSession() as session:
|
||||||
async with session.get('http://aws.random.cat/meow') as r:
|
async with session.get('http://aws.random.cat/meow') as r:
|
||||||
@ -319,7 +329,9 @@ and set the embed's image URL to ``attachment://image.png``,
|
|||||||
where ``image.png`` is the filename of the image you will send.
|
where ``image.png`` is the filename of the image you will send.
|
||||||
|
|
||||||
|
|
||||||
Quick example: ::
|
Quick example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
file = discord.File("path/to/my/image.png", filename="image.png")
|
file = discord.File("path/to/my/image.png", filename="image.png")
|
||||||
embed = discord.Embed()
|
embed = discord.Embed()
|
||||||
@ -327,7 +339,7 @@ Quick example: ::
|
|||||||
await channel.send(file=file, embed=embed)
|
await channel.send(file=file, embed=embed)
|
||||||
|
|
||||||
Is there an event for audit log entries being created?
|
Is there an event for audit log entries being created?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Since Discord does not dispatch this information in the gateway, the library cannot provide this information.
|
Since Discord does not dispatch this information in the gateway, the library cannot provide this information.
|
||||||
This is currently a Discord limitation.
|
This is currently a Discord limitation.
|
||||||
@ -361,14 +373,18 @@ to a message. Example::
|
|||||||
Why do my arguments require quotes?
|
Why do my arguments require quotes?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
In a simple command defined as: ::
|
In a simple command defined as:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def echo(ctx, message: str):
|
async def echo(ctx, message: str):
|
||||||
await ctx.send(message)
|
await ctx.send(message)
|
||||||
|
|
||||||
Calling it via ``?echo a b c`` will only fetch the first argument and disregard the rest. To fix this you should either call
|
Calling it via ``?echo a b c`` will only fetch the first argument and disregard the rest. To fix this you should either call
|
||||||
it via ``?echo "a b c"`` or change the signature to have "consume rest" behaviour. Example: ::
|
it via ``?echo "a b c"`` or change the signature to have "consume rest" behaviour. Example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def echo(ctx, *, message: str):
|
async def echo(ctx, *, message: str):
|
||||||
@ -382,7 +398,9 @@ How do I get the original ``message``\?
|
|||||||
The :class:`~ext.commands.Context` contains an attribute, :attr:`~.Context.message` to get the original
|
The :class:`~ext.commands.Context` contains an attribute, :attr:`~.Context.message` to get the original
|
||||||
message.
|
message.
|
||||||
|
|
||||||
Example: ::
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
@bot.command()
|
@bot.command()
|
||||||
async def length(ctx):
|
async def length(ctx):
|
||||||
@ -394,7 +412,9 @@ How do I make a subcommand?
|
|||||||
Use the :func:`~ext.commands.group` decorator. This will transform the callback into a :class:`~ext.commands.Group` which will allow you to add commands into
|
Use the :func:`~ext.commands.group` decorator. This will transform the callback into a :class:`~ext.commands.Group` which will allow you to add commands into
|
||||||
the group operating as "subcommands". These groups can be arbitrarily nested as well.
|
the group operating as "subcommands". These groups can be arbitrarily nested as well.
|
||||||
|
|
||||||
Example: ::
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: python3
|
||||||
|
|
||||||
@bot.group()
|
@bot.group()
|
||||||
async def git(ctx):
|
async def git(ctx):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user