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

add & apply pyproject-fmt #839

Closed
wants to merge 1 commit into from

Conversation

CagtayFabry
Copy link
Member

Changes

Describe changes in this PR

Related Issues

Closes # (add issue numbers)

Checks

  • updated CHANGELOG.rst
  • updated tests
  • updated doc/
  • update example/tutorial notebooks
  • update manifest file

@github-actions
Copy link

Test Results

2 184 tests  ±0   2 183 ✔️ ±0   3m 40s ⏱️ + 1m 9s
       1 suites ±0          1 💤 ±0 
       1 files   ±0          0 ±0 

Results for commit 13d18d6. ± Comparison against base commit 17a5c1f.

@codecov
Copy link

codecov bot commented Jan 13, 2023

Codecov Report

Merging #839 (13d18d6) into master (17a5c1f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #839   +/-   ##
=======================================
  Coverage   96.83%   96.83%           
=======================================
  Files          92       92           
  Lines        6071     6071           
=======================================
  Hits         5879     5879           
  Misses        192      192           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@marscher
Copy link
Contributor

great, it sorted everything 👍 As the file is basically a dictionary, there would be no need to sort it all. I used the same ordering as it used to be in setup.cfg.

Validation to a schema sounds great. Who is maintaining this schema? Earlier, potential problems about the file just popped out as setuptools warnings. This is a much better way.

@CagtayFabry
Copy link
Member Author

great, it sorted everything 👍 As the file is basically a dictionary, there would be no need to sort it all. I used the same ordering as it used to be in setup.cfg.

Validation to a schema sounds great. Who is maintaining this schema? Earlier, potential problems about the file just popped out as setuptools warnings. This is a much better way.

We can also do away with the sorting but I guess for future comparability it might be usefull

I haven't looked into the schema verification, just saw it pop up over at the asdf repo

@marscher
Copy link
Contributor

I'd opt out sorting, as sometimes it might be useful to place keys logically next to each other (e.g. pairs of settings, which belong together, but have different section names).

@CagtayFabry
Copy link
Member Author

I'd opt out sorting, as sometimes it might be useful to place keys logically next to each other (e.g. pairs of settings, which belong together, but have different section names).

It don't think you can opt out of the sorting (but some keys also seem like manually sorted)

@marscher
Copy link
Contributor

The tool also does not seem to handle comments, which is a bummer as I like to document this file a little bit.

@marscher
Copy link
Contributor

So I'd just skip the formatting at all (PyCharm also does a good job in formatting it) and just use the validation.

@CagtayFabry
Copy link
Member Author

So I'd just skip the formatting at all (PyCharm also does a good job in formatting it) and just use the validation.

sounds good for now, the formatting also removes comments which is not ideal imo

@CagtayFabry
Copy link
Member Author

I'll open a new PR for this

@CagtayFabry
Copy link
Member Author

closing this for #841

@CagtayFabry CagtayFabry deleted the pyproject_fmt branch January 26, 2023 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants