Document merge base and GitAnnotated #23437
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
kshyatt
added
docs
ararslan
reviewed
Aug 24, 2017
| the commit. Conflict files contain information about the source/target branches in | ||
| the merge which are conflicting, for instance. An annotated commit can refer to the | ||
| tip of a remote branch, for instance when a [`FetchHead`](@ref) is passed, or to a | ||
| branch head described using `GitReference`. |
There was a problem hiding this comment.
I really like this description! It would be good to mention what the GitAnnotated constructor does or returns though. It gives you a GitAnnotated, which is an annotated commit object, right?
There was a problem hiding this comment.
Yes. I'm glad the description is useful. It seemed clear to me that these are c-tors but maybe not...
There was a problem hiding this comment.
Yeah, I guess it's fine as-is.
ararslan
approved these changes
Aug 25, 2017
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.