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

Add ruff to check code #54

Closed
maurapintor opened this issue Mar 16, 2024 · 0 comments · Fixed by #57
Closed

Add ruff to check code #54

maurapintor opened this issue Mar 16, 2024 · 0 comments · Fixed by #57
Assignees
@maurapintor
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@maurapintor
Copy link
Collaborator

maurapintor commented Mar 16, 2024 •
edited
Loading

This will enforce:

  • proper docstrings
  • proper type annotations
  • proper coding style

Black can be removed, as Ruff is a much more powerful tool.

A pre-commit config file will also be added, so that developers will be aided for the verification before pushing the code to the repository.

Instructions will be added to the contribution guide.

https://github.com/astral-sh/ruff
@maurapintor maurapintor added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 16, 2024
@maurapintor maurapintor self-assigned this Mar 16, 2024
This was referenced Mar 16, 2024
Closed
Merged
@maurapintor maurapintor linked a pull request Mar 16, 2024 that will close this issue
Add documentation, tests, and automatic tools #57
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maurapintor maurapintor

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation, tests, and automatic tools pralab/secml-torch
1 participant
@maurapintor