docs/tutorial.md: introduce both long and short names of each option #2415
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
martinvonz
approved these changes
Oct 23, 2023
There was a problem hiding this comment.
This looks good to me, thanks. Feel free to merge if you prefer this over #2409 (I think I do). The commit from #2409 dropping the mention of heads() still makes sense. Feel free to move/copy that into this PR before merging, or leaving only that commit in the other PR, or open a new PR just for that.
Instead we point explicitly at the full documentation on revsets. Suggested-by: Martin von Zweigbergk <[email protected]>
|
Thanks! I removed the mention of |
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 is an alternative to #2409 , as discussed in #2409 (comment) .
I found the
rebasepart of the tutorial confusing due to the use of machine-dependent change IDs on an unknown command. #2409 fixes this by referring to changes by their description, but this is un-idiomatic and does not scale to real repositories. The present PR instead explains therebaseoptions before using them, with the clearer long names. All other options in the tutorial are changed to this style for consistency.