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

[JOSS Review] Functionality documentation: linting/style #88

Closed
davidegraff opened this issue May 23, 2022 · 1 comment · Fixed by #91
Closed

[JOSS Review] Functionality documentation: linting/style #88

davidegraff opened this issue May 23, 2022 · 1 comment · Fixed by #91

Comments

@davidegraff
Copy link

cc openjournals/joss-reviews#4337

The code is documented and largely formatted with flake8 but there are a few nitpicks:

  • $ flake8 --ignore E501 RIAssigner > flake8.log still outputs some minor errors:
    (flake8.log)
  • asserts are used when a ValueError should be used instead (e.g., 1, 2, and 3. asserts should be avoided for client-side error-checking (i.e., invalid input values) because they can be entirely disabled
@hechth
Copy link
Member

hechth commented May 24, 2022

@davidegraff thank you very much for the useful hint - I wasn't aware of that regarding asserts - will fix that accordingly!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants