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

docs: improve updating pre-commit documentation #1361

Merged
merged 5 commits into from
Jan 15, 2024
Merged

docs: improve updating pre-commit documentation #1361

merged 5 commits into from
Jan 15, 2024

Conversation

12rambau
Copy link
Contributor

@12rambau 12rambau commented Oct 6, 2023

  • there was a inconsistence between the inline and rej default. as it's inline I changed the value in the corrected section
  • as users won't need the 2 options at once, I split the 2 hooks.

- there was a inconsistence between the inline and rej default. as it's inline I changed the value in the corrected section
- as users won't need the 2 options at once, I split the 2 hooks.
Copy link
Member

@sisp sisp left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution and also for catching the outdated default value for the --conflict flag, @12rambau! 🙏

I have only a few minor remarks.

docs/updating.md Outdated Show resolved Hide resolved
docs/updating.md Outdated Show resolved Hide resolved
Copy link
Member

@yajo yajo left a comment

Choose a reason for hiding this comment

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

I think it's good to keep both examples together. In a shared project, one user might use rej mode, while others use inline mode. In any case, you don't want those files committed.

If you want to keep them split because of clarity, at least please explain this point too.

@codecov
Copy link

codecov bot commented Oct 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5113d14) 97.19% compared to head (2eb2f6d) 97.46%.
Report is 79 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1361      +/-   ##
==========================================
+ Coverage   97.19%   97.46%   +0.26%     
==========================================
  Files          48       48              
  Lines        4280     4537     +257     
==========================================
+ Hits         4160     4422     +262     
+ Misses        120      115       -5     
Flag Coverage Δ
unittests 97.46% <ø> (+0.26%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bswck
Copy link

bswck commented Jan 12, 2024

The current documentation is confusing. At first it is stated that --conflict inline is the default, and later that --conflict rej is.

@yajo
Copy link
Member

yajo commented Jan 15, 2024

In that case, the default is inline.

@yajo yajo enabled auto-merge (squash) January 15, 2024 17:51
sisp
sisp previously requested changes Jan 15, 2024
Copy link
Member

@sisp sisp left a comment

Choose a reason for hiding this comment

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

Just some final polishing. 😉

docs/updating.md Outdated Show resolved Hide resolved
docs/updating.md Outdated Show resolved Hide resolved
@yajo yajo requested a review from sisp January 15, 2024 18:17
@sisp
Copy link
Member

sisp commented Jan 15, 2024

Oh, and CI is failing because Prettier wants a line wrap in the pre-commit-config.yaml snippet. It's probably best to make this a proper multiline YAML string:

description: >
  found Copier ...
  ...

Co-authored-by: Sigurd Spieckermann <[email protected]>
@yajo
Copy link
Member

yajo commented Jan 15, 2024

Fixed

Copy link
Member

@sisp sisp left a comment

Choose a reason for hiding this comment

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

Perfect, thanks! 👌

@yajo yajo dismissed sisp’s stale review January 15, 2024 18:32

All attended

@yajo yajo merged commit ee5c106 into copier-org:master Jan 15, 2024
21 checks passed
@12rambau 12rambau deleted the patch-1 branch January 16, 2024 07:31
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.

4 participants