Ruby-Cogs/dictionary
2025-04-02 22:57:51 -04:00
..
locales Add Cogs 2025-04-02 22:57:51 -04:00
__init__.py Add Cogs 2025-04-02 22:56:57 -04:00
dictionary.py Add Cogs 2025-04-02 22:56:57 -04:00
info.json Add Cogs 2025-04-02 22:56:57 -04:00
README.rst Add Cogs 2025-04-02 22:57:51 -04:00
types.py Add Cogs 2025-04-02 22:57:51 -04:00
utils_version.json Add Cogs 2025-04-02 22:57:51 -04:00
view.py Add Cogs 2025-04-02 22:57:51 -04:00

.. _dictionary:
==========
Dictionary
==========

This is the cog guide for the ``Dictionary`` cog. This guide contains the collection of commands which you can use in the cog.
Through this guide, ``[p]`` will always represent your prefix. Replace ``[p]`` with your own prefix when you use these commands in Discord.

.. note::

    Ensure that you are up to date by running ``[p]cog update dictionary``.
    If there is something missing, or something that needs improving in this documentation, feel free to create an issue `here <https://github.com/AAA3A-AAA3A/AAA3A-cogs/issues>`_.
    This documentation is generated everytime this cog receives an update.

---------------
About this cog:
---------------

A cog to search an english term/word in the dictionary! Synonyms, antonyms, phonetics (with audio)...

---------
Commands:
---------

Here are all the commands included in this cog (1):

* ``[p]dictionary <query>``
 Search a word in the english dictionnary.

------------
Installation
------------

If you haven't added my repo before, lets add it first. We'll call it "AAA3A-cogs" here.

.. code-block:: ini

    [p]repo add AAA3A-cogs https://github.com/AAA3A-AAA3A/AAA3A-cogs

Now, we can install Dictionary.

.. code-block:: ini

    [p]cog install AAA3A-cogs dictionary

Once it's installed, it is not loaded by default. Load it by running the following command:

.. code-block:: ini

    [p]load dictionary

----------------
Further Support:
----------------

Check out my docs `here <https://aaa3a-cogs.readthedocs.io/en/latest/>`_.
Mention me in the #support_other-cogs in the `cog support server <https://discord.gg/GET4DVk>`_ if you need any help.
Additionally, feel free to open an issue or pull request to this repo.

--------
Credits:
--------

Thanks to Kreusada for the Python code to automatically generate this documentation!