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

Updates readme.md #53

Closed
wants to merge 1 commit into from
Closed

Conversation

purva-thakre
Copy link
Contributor

@purva-thakre purva-thakre commented Jun 13, 2021

Updates readme with information about formatting and style. I couldn't find any information about this in qutip's documentation or was looking at the wrong pages.

This instructs a user to install Black and ways to format their code. The defaults set by Black have not been changed but could be edited.If another package is preferred, then I can change the lines for preferred package.

I do think there needs to be additional information regarding the use of Black in documentation and/or test files. Will add this after I get a feedback on this initial PR.

@nathanshammah nathanshammah requested review from nathanshammah and BoxiLi and removed request for nathanshammah June 13, 2021 16:10
@purva-thakre
Copy link
Contributor Author

Actually, I think it's better to close this for now.

There's a lot of files that need to be re-formatted. It's better to create a separate issue to handle the errors one by one + verify these changes are needed. Then maybe this information could be added after black doesn't give any errors in existing files.

@BoxiLi
Copy link
Member

BoxiLi commented Jun 13, 2021

Yeah, there are many files that are not in the ideal pip8 format at the moment. We can add it as a suggestion for contributors, not a requirement.

If we slowly require all our new code to be pip8 formated. Things will get better.

And if we were to add this, it is better to add it to the contributing to code in the doc, I think, rather than in readme.

@purva-thakre purva-thakre deleted the format_style branch June 14, 2021 01:30
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.

None yet

2 participants