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

Pre-commit #68

Open
2 tasks
NoraLoose opened this issue Sep 4, 2024 · 2 comments · Fixed by #73
Open
2 tasks

Pre-commit #68

NoraLoose opened this issue Sep 4, 2024 · 2 comments · Fixed by #73
Assignees
@NoraLoose

Comments

@NoraLoose
Copy link
Contributor

NoraLoose commented Sep 4, 2024 •
edited
Loading

We want to take advantage of pre-commit in two ways beyond what it's doing now in the C-Star repo:

  • Include it in the CI
  • Let it format the docstrings correctly for us (e.g., via docformatter or pdocstyle) because the docstrings are not showing up correctly in the documentation, see all these warnings

Screenshot 2024-09-04 at 2 37 35 PM
@NoraLoose NoraLoose changed the title a Add pre-commit to CI Sep 4, 2024
@NoraLoose NoraLoose changed the title Add pre-commit to CI Pre-commit Sep 4, 2024
@dafyddstephenson
Copy link
Contributor

I think this one is covered by #11 ?

@NoraLoose NoraLoose mentioned this issue Sep 4, 2024
Closed
@NoraLoose NoraLoose self-assigned this Sep 4, 2024
@dafyddstephenson dafyddstephenson mentioned this issue Sep 6, 2024
Merged
@NoraLoose
Copy link
Contributor Author

This issue should be re-opened as outlined in #80

@NoraLoose NoraLoose reopened this Sep 16, 2024
@NoraLoose NoraLoose mentioned this issue Sep 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NoraLoose NoraLoose

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

change to pyproject.toml and add pre-commit to CI dafyddstephenson/C-Star
2 participants
@NoraLoose @dafyddstephenson