Harmonize commitish and committish in docstrings #799
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
The git glossary mentions both verions. However in-code, only the first variant is used. This commit harmonizes the usages: https://git-scm.com/docs/gitglossary#Documentation/ gitglossary.txt-aiddefcommit-ishacommit-ishalsocommittish
sgasse
commented
Feb 5, 2022
Comment on lines
-834
to
836
| /// If the provided committish cannot be found in the repository, the HEAD | ||
| /// If the provided commitish cannot be found in the repository, the HEAD | ||
| /// is unaltered and an error is returned. | ||
| /// If the provided commitish cannot be peeled into a commit, the HEAD is |
There was a problem hiding this comment.
e.g. here we have both spellings directly one after another - so maybe it makes sense to harmonize it? Or does it not make any sense because it we might get both variants back anyway?
|
Seems reasonable! |
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.
The git glossary mentions both verions. However in-code, only the first
variant is used. This commit harmonizes the usages:
https://git-scm.com/docs/gitglossary#Documentation/
gitglossary.txt-aiddefcommit-ishacommit-ishalsocommittish