alchemistry / alchemlyb

the simple alchemistry library
https://alchemlyb.readthedocs.io
BSD 3-Clause "New" or "Revised" License
189 stars 49 forks source link

Blackfy the code #280

Closed xiki-tempula closed 1 year ago

xiki-tempula commented 1 year ago

Refactor the code according to black and add black check to the ci.

codecov[bot] commented 1 year ago

Codecov Report

Merging #280 (f07fb18) into master (380302d) will not change coverage. The diff coverage is 99.09%.

@@           Coverage Diff           @@
##           master     #280   +/-   ##
=======================================
  Coverage   98.69%   98.69%           
=======================================
  Files          26       26           
  Lines        1761     1761           
  Branches      379      379           
=======================================
  Hits         1738     1738           
  Misses          3        3           
  Partials       20       20           
Impacted Files Coverage Δ
src/alchemlyb/postprocessors/__init__.py 100.00% <ø> (ø)
src/alchemlyb/workflows/__init__.py 100.00% <ø> (ø)
src/alchemlyb/visualisation/dF_state.py 95.83% <92.30%> (ø)
src/alchemlyb/parsing/gomc.py 93.33% <95.65%> (ø)
src/alchemlyb/workflows/abfe.py 99.66% <99.22%> (ø)
src/alchemlyb/__init__.py 100.00% <100.00%> (ø)
src/alchemlyb/convergence/convergence.py 100.00% <100.00%> (ø)
src/alchemlyb/estimators/__init__.py 100.00% <100.00%> (ø)
src/alchemlyb/estimators/bar_.py 100.00% <100.00%> (ø)
src/alchemlyb/estimators/base.py 100.00% <100.00%> (ø)
... and 15 more

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

xiki-tempula commented 1 year ago

@orbeckst If one doesn't want to blackfy certain regions of code, one could use something similar to 'param: no cover' to allow black to ignore it.

orbeckst commented 1 year ago

Yeah, it's ok. I think I am ok with the trade-off between not having to think about formatting ever again and making minor decisions about preferred/marginally more legible indentation etc. It's fine.