git_note_create: Copyediting on documentation for the oid parameter #872
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
| @@ -77,7 +77,7 @@ | |||
| * @param notes_ref OID reference to use (optional); defaults to "refs/notes/commits" | |||
| * @param author signature of the notes commit author | |||
| * @param committer signature of the notes commit committer | |||
| * @param oid the oid which note's to be removed | |||
| * @param oid The OID whose notes to remove | |||
There was a problem hiding this comment.
How about The OID of the git object which should see its note removed?
There was a problem hiding this comment.
"which should see its note removed" seems highly awkward to me. However, "of the git object" seems like an informative addition.
How about "The OID of the git object to remove notes from"?
There was a problem hiding this comment.
How about "The OID of the git object to remove notes from"?
Deal. However, please use the singular form. Only one note per git object per namespace is allowed.
vmg
pushed a commit
that referenced
this pull request
Aug 14, 2012
git_note_create: Copyediting on documentation for the oid parameter
phatblat
pushed a commit
to phatblat/libgit2
that referenced
this pull request
Sep 13, 2014
git_note_create: Copyediting on documentation for the oid parameter
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.
No description provided.