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

Poor documentation, Poor comments, Poor PEP8 #1

Open
3 tasks
dinhanhx opened this issue Sep 13, 2020 · 2 comments
Open
3 tasks

Poor documentation, Poor comments, Poor PEP8 #1

dinhanhx opened this issue Sep 13, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@dinhanhx
Copy link
Owner

dinhanhx commented Sep 13, 2020

As the title said, documentation for this lib is just one single file DOCUMENTATION.md.

Comments and long LoC don't follow PEP8.

Please someone make a doc for this by using readthedocs and format comments as well as long LoC.

Everything is poor
I know

List of works:

  • Enforce PEP8
  • Make comments pretty
  • Make documentations
@dinhanhx dinhanhx added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 13, 2020
@Huy-Ngo
Copy link

Huy-Ngo commented Oct 7, 2020

Should the file/variable names be renamed then? The PascalCase file naming doesn't follow usual Python convention, but changing it also mean new versions won't be compatible with the older ones.

@dinhanhx
Copy link
Owner Author

dinhanhx commented Oct 7, 2020

Since number of people using this package is small. You can rename files and variables

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants