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

Format pyproject.toml file with pyproject-fmt using pre-commit #102

Merged
merged 4 commits into from
Sep 30, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Sep 30, 2024

Description

This PR adds a pre-commit check and formatting step leveraging pyproject-fmt to help standardize the formatting found within the file, similar to how black or ruff-format work with Python code.

Additionally - I moved inline comments for dependencies to be above their related lines (to conserve line space) and updated the version of the project to be in alignment with dynamic versioning (0.0.0).

What kind of change(s) are included?

  • Documentation (changes docs or other related content)
  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs marked this pull request as ready for review September 30, 2024 16:02
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! That formatter did wonders on the TOML file, looks great!

pyproject.toml Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Sep 30, 2024

Thanks @jenna-tomkinson ! I've created an issue for the versioning item (I don't believe there's any additional configuration we need at this time). Merging this in.

@d33bs d33bs merged commit 410fab2 into WayScience:main Sep 30, 2024
9 checks passed
@d33bs d33bs deleted the format-pyproject branch September 30, 2024 18:54
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 this pull request may close these issues.

2 participants