BAMWelDX / weldx

The welding data exchange format
https://www.bam.de/weldx
BSD 3-Clause "New" or "Revised" License
19 stars 9 forks source link

add & apply pyproject-fmt #839

Closed CagtayFabry closed 1 year ago

CagtayFabry commented 1 year ago

Changes

Describe changes in this PR

Related Issues

Closes # (add issue numbers)

Checks

github-actions[bot] commented 1 year ago

Test Results

2 184 tests  ±0   2 183 :heavy_check_mark: ±0   3m 40s :stopwatch: + 1m 9s        1 suites ±0          1 :zzz: ±0         1 files   ±0          0 :x: ±0 

Results for commit 13d18d6f. ± Comparison against base commit 17a5c1f5.

codecov[bot] commented 1 year ago

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 commented 1 year ago

great, it sorted everything :+1: 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 commented 1 year ago

great, it sorted everything :+1: 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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

marscher commented 1 year ago

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

CagtayFabry commented 1 year ago

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 commented 1 year ago

I'll open a new PR for this

CagtayFabry commented 1 year ago

closing this for #841