MDAnalysis / UserGuide

User Guide for MDAnalysis
https://userguide.mdanalysis.org
22 stars 35 forks source link

Black for developers #383

Closed RMeli closed 1 month ago

RMeli commented 1 month ago

This PR explains how developers are supposed to use black to format the code base, if this tool will be adopted by MDAnalysis. In such case this will become a required step of the PR process.


📚 Documentation preview 📚: https://mdanalysisuserguide--383.org.readthedocs.build/en/383/

RMeli commented 1 month ago

@MDAnalysis/coredevs @marinegor

The companion PR https://github.com/MDAnalysis/mdanalysis/pull/4717 add a black configuration to package and testsuite so that the commands in the documentation

black package
black testsuite

do nothing.

RMeli commented 1 month ago

Thanks @IAlibay. I'll merge this if/when https://github.com/MDAnalysis/mdanalysis/pull/4725 is merged.