Fix typos in config support info #1531
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- `core.looseCompression` - use canonical capitalization for key - `core.packedGitLimit` - work well on 64-bit, not 32-bit (GitoxideLabs#1530) - `core.sparseCheckoutCone` - fix misspelled `sparseCheckout` ref - `submodule.recurse` - fix minor spelling typo
Byron
approved these changes
Aug 22, 2024
There was a problem hiding this comment.
Thanks a lot, appreciated!
This information is available by API, so maybe this should be a conventional commit? I can easily amend this so the commit message starts with
fix:if you like. This seems like a gray area with respect to whetherfix:ought to be used.
That's an interesting question - I'd think of it as documentation change or fix, for which there could be the doc: prefix, but I never tried it before and only hope it works.
I think that and more can be tried in a subsequent PR, let's not let this one wait any longer (as the effect of not having it in the changelog is probably very minor).
EliahKagan
added a commit
to EliahKagan/gitoxide
that referenced
this pull request
Aug 22, 2024
This builds on b31d6b7 (GitoxideLabs#1531) by adjusting the capitalization and quoting style of string arguments in `progress.rs` that help document the status of what configuration options are and are not planned. - Since I believe these strings are not usually rendered as Markdown, and most places that code formatting in Markdown would be used were already written with single quotes, this applies that quoting style consistently. - This applies initial capitalization, which was sometimes but not always done. It does not apply a consistent style for when a string will end in a `.`, which seems already to differ deliberately for reasons of clarity. That can be adjusted later. - A small amount of minor rewording for clarity is also included.
|
I've opened #1537 for those further changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes #1530 and makes some other minor improvements.
core.looseCompression- use canonical capitalization for keycore.packedGitLimit- work well on 64-bit, not 32-bit (#1530)core.sparseCheckoutCone- fix misspelledsparseCheckoutrefsubmodule.recurse- fix minor spelling typoFurther improvements are possible, such as to unify the style of the explanations so that they all follow the same capitalization and quoting conventions. I believe that should be done, but since I may inquire about other substantive areas soon anyway (as I did in #1530), I think that can wait until a subsequent PR.
This information is available by API, so maybe this should be a conventional commit? I can easily amend this so the commit message starts with
fix:if you like. This seems like a gray area with respect to whetherfix:ought to be used.