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

README: Add notes on using auto-formatting tools. #1192

Merged
merged 2 commits into from
Apr 17, 2022

Conversation

neiljp
Copy link
Collaborator

@neiljp neiljp commented Apr 10, 2022

What does this PR do?

Document our use of black and isort.

Tested?

  • Manually

@neiljp neiljp added area: documentation Requires changes in documentation area: infrastructure Project infrastructure labels Apr 10, 2022
@neiljp neiljp added this to the Next Release milestone Apr 10, 2022
@zulipbot zulipbot added size: S [Automatic label added by zulipbot] size: M [Automatic label added by zulipbot] and removed size: S [Automatic label added by zulipbot] labels Apr 10, 2022
README.md Outdated
the changes.

You can also use the tools individually on a file or directory, eg.
`black zulipterminal` or `isort/tests/model/test_model.py`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it needs to be isort tests/model/test_model.py. There's a slash instead of space after isort.

@mounilKshah
Copy link
Collaborator

Apart from this one change, everything else seems fine to me.

@neiljp neiljp force-pushed the 2022-04-09-auto-formatting-docs branch from c086f0a to 99c8aee Compare April 17, 2022 06:10
@neiljp neiljp merged commit 13a1a4c into zulip:main Apr 17, 2022
@neiljp
Copy link
Collaborator Author

neiljp commented Apr 17, 2022

@mounilKshah Thanks for the review 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Requires changes in documentation area: infrastructure Project infrastructure size: M [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants