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 #232

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Sep 26, 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.

Closes #156

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

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

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs changed the title Format pyproject.toml file with pyproject-fmt using pre-commit Format pyproject.toml file with pyproject-fmt using pre-commit Sep 26, 2024
@d33bs d33bs marked this pull request as ready for review September 26, 2024 15:55
@d33bs
Copy link
Member Author

d33bs commented Sep 26, 2024

Thank you @gwaybio ! Merging this in.

@d33bs d33bs merged commit 9731904 into cytomining:main Sep 26, 2024
12 checks passed
@d33bs d33bs deleted the pyproject-formatting branch September 26, 2024 16:56
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.

Use TOML formatter to enhance readability and consistent structure
2 participants