Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Millorar la comanda d'ajuda #8

Open
vicky5124 opened this issue Apr 4, 2022 · 0 comments
Open

Millorar la comanda d'ajuda #8

vicky5124 opened this issue Apr 4, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@vicky5124
Copy link
Owner

S'ha de documentar bé el codi, i reemplaçar la comanda per defecte help amb una personalitzada, que mostri més informació directament.

Per a documentar ajuda en comandes, a part de les descripcions dels paràmetres, i la descripció curta de la comanda, es pot utilitzar una docstring per a una ajuda més completa:

@bot.command()
async def cmd_name(ctx):
    """
    Aixo es una docstring.
    Aqui es pot posar el contingut que es mostrara quan s'invoqui `/help cmd_name`
    """
    pass
@vicky5124 vicky5124 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant