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

Inconsistent docstrings #66

Closed
3 of 4 tasks
s0lst1ce opened this issue Jul 29, 2019 · 5 comments
Closed
3 of 4 tasks

Inconsistent docstrings #66

s0lst1ce opened this issue Jul 29, 2019 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed quality all issues which only affect the way code is written and that won't affect functionnality

Comments

@s0lst1ce
Copy link
Collaborator

s0lst1ce commented Jul 29, 2019

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
@s0lst1ce s0lst1ce added bug Something isn't working enhancement New feature or request help wanted Extra attention is needed quality all issues which only affect the way code is written and that won't affect functionnality labels Jul 29, 2019
@s0lst1ce
Copy link
Collaborator Author

@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.

@s0lst1ce s0lst1ce pinned this issue Jul 29, 2019
@s0lst1ce
Copy link
Collaborator Author

This is also part of #71

@s0lst1ce s0lst1ce added the good first issue Good for newcomers label Oct 27, 2019
@s0lst1ce
Copy link
Collaborator Author

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

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Dec 6, 2019

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 😛

@s0lst1ce s0lst1ce unpinned this issue Dec 6, 2019
@s0lst1ce s0lst1ce mentioned this issue Dec 6, 2019
2 tasks
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Dec 7, 2019

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.

@s0lst1ce s0lst1ce closed this as completed Dec 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed quality all issues which only affect the way code is written and that won't affect functionnality
Projects
None yet
Development

No branches or pull requests

1 participant