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

Document some culprits with pre-commit #1783

Merged
merged 4 commits into from
Oct 27, 2020
Merged

Document some culprits with pre-commit #1783

merged 4 commits into from
Oct 27, 2020

Conversation

Bibo-Joshi
Copy link
Contributor

This PR adds some documentation about version control integration in hopes of preventing duplicatos of #1778 and #1773 :)

Bibo-Joshi and others added 2 commits October 23, 2020 18:06
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@ichard26 ichard26 self-requested a review October 23, 2020 16:25
Copy link
Collaborator

@ichard26 ichard26 left a comment

Choose a reason for hiding this comment

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

Looks good! I personally would like an explanation to why --exclude/--include can't be depended on when using pre-commit to be added but I don't care enough to press "request changes" instead.

Thanks for taking some time to work on this @Bibo-Joshi!

@ichard26 ichard26 added T: documentation Improvements to the docs (e.g. new topic, correction, etc) C: integrations Editor plugins and other integrations labels Oct 23, 2020
@Bibo-Joshi
Copy link
Contributor Author

Looks good! I personally would like an explanation to why --exclude/--include can't be depended on when using pre-commit to be added but I don't care enough to press "request changes" instead.

I thought about that, but trying to give a short explanation might actually be more confusing. One could just link to the two issues, but that's not too nice to have in the documentation …

@cooperlees cooperlees merged commit cabeb5b into psf:master Oct 27, 2020
@Bibo-Joshi Bibo-Joshi deleted the pre-commit-docs branch October 28, 2020 06:57
noxan pushed a commit to noxan/black that referenced this pull request Jun 6, 2021
* Document some culprits with pre-commit

* make pre-commit happy

* don't use monospace for black & pre-commit

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

* make pre-commit happy again

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: integrations Editor plugins and other integrations T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants