Giters

Botanism / Botanist

A bot for a healthier experience on discord servers. Provides lots of moderation utilities and improved sharing features!

Home Page:https://discord.gg/mpGM5cg

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Inconsistent docstrings

s0lst1ce opened this issue · comments

commented

My feature request is about

  • A new feature
  • Changing a feature

Description of the issue & the solution I'd like
Currently the command docstrings which form the description for the help command are inconsistent with the official documentation of the README.md. This should need to be fixed because it may confuse the one reading both documentation sources. Also the in-discord help can be confusing and don't respect PEP257.

What needs to be done

  • Write docstrings for all commands
  • Make the docstrings consistent with the documentation
  • Make the docstrings PEP257 compliant
  • Find a maintainer for the docstrings
commented

@Webatron11 I recall you wanted something useful to do? This could be it.
@morcup If you want to help further with the project you're also free to pick this up.

commented

This is also part of #71

commented

Because of #73 this is now done though the language file in the lang folder.

commented

These are not docstrings anymore since they're not used by the help command anymore. Hence we don't need to make them PEP complaint 😛

commented

No more need for docstrings at all so I'm closing this. Still some strings aren't the same on the docs and/or aren't very well written so they'll need improvement. This will be done through #73 though.