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

Documentation and Lint #59

Open
GrimTheReaper opened this issue Oct 2, 2019 · 2 comments
Open

Documentation and Lint #59

GrimTheReaper opened this issue Oct 2, 2019 · 2 comments

Comments

@GrimTheReaper
Copy link

GrimTheReaper commented Oct 2, 2019 •
edited
Loading

When I brought this project down into my workspace, I noticed that almost every function does not have any comments for them, leading to the linter showing a bunch of issues. Would you mind if I went about cleaning up and documenting things for you?

image
@GrimTheReaper GrimTheReaper changed the title Pass Lint Documentation and Lint Oct 2, 2019
@coelho
Copy link
Member

coelho commented Sep 28, 2020

Late reply, I know,

If someone wants to PR documentation, I'm happy with that. However, it is a rabbit hole I'd like to avoid with never-ending maintenance so I'd prefer to rename & clarify anywhere in the code that is unclear so that it can be better understood instead.

@GrimTheReaper
Copy link
Author

GrimTheReaper commented Sep 28, 2020 •
edited
Loading

@coelho if you're coming back and being more active towards this project, I could donate my time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@coelho @GrimTheReaper