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

Black for developers #383

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Black for developers #383

wants to merge 3 commits into from

Conversation

RMeli
Copy link
Member

@RMeli RMeli commented Sep 24, 2024

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
Copy link
Member Author

RMeli commented Sep 24, 2024

@MDAnalysis/coredevs @marinegor

The companion PR MDAnalysis/mdanalysis#4717 add a black configuration to package and testsuite so that the commands in the documentation

black package
black testsuite

do nothing.

doc/source/contributing_code.rst Show resolved Hide resolved
@IAlibay IAlibay marked this pull request as ready for review October 3, 2024 11:59
@RMeli
Copy link
Member Author

RMeli commented Oct 3, 2024

Thanks @IAlibay. I'll merge this if/when MDAnalysis/mdanalysis#4725 is merged.

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.

2 participants