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

[JOSS review] Functionality documentation - linting #25

Closed
rvhonorato opened this issue Jan 12, 2022 · 1 comment
Closed

[JOSS review] Functionality documentation - linting #25

rvhonorato opened this issue Jan 12, 2022 · 1 comment

Comments

@rvhonorato
Copy link

Companion of openjournals/joss-reviews/issues/3950

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

The code is well documented but it does not adhere to pep8 style, my recommendation would be to enforce code style in the repository via github actions and solve the many issues:

$ flake8 --ignore E501 --count > flake8.log

flake8.log
@davidegraff davidegraff mentioned this issue Feb 25, 2022
Merged
1 task
@davidegraff
Copy link
Collaborator

this should be fixed in the recent PR- closing for now!

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
@rvhonorato @davidegraff