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.

Sign up for GitHub

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

Jump to bottom

Needs Documentation #59

Closed
ngomile opened this issue Aug 4, 2018 · 2 comments
Closed

Needs Documentation #59

ngomile opened this issue Aug 4, 2018 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@ngomile
Copy link
Contributor

ngomile commented Aug 4, 2018

Currently the documentation of anime-downloader is lacking and that's making it difficult to incorporate some changes or just understand what's going on. While I have managed to grasp how this is working for the most part, I think that better comments in the source such as making use of docstrings will be helpful. Not only will this get others like myself up to speed but it will make contributing less painful and understand why some decisions were made. Thank you.
@vn-ki
Copy link
Collaborator

vn-ki commented Aug 4, 2018

Please check out the wiki for basic usage.

Also, I agree that the code has to be commented. I was thinking of making use of sphinx and moving the docs to readthedocs.

@vn-ki vn-ki added enhancement New feature or request good first issue Good for newcomers labels Aug 4, 2018
@1ijack 1ijack mentioned this issue Aug 8, 2018
Closed
@vn-ki
Copy link
Collaborator

vn-ki commented May 8, 2019

Fixed in rewrite

@vn-ki vn-ki closed this as completed May 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vn-ki @ngomile