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.
I switched the example to be about the
link <dir>
case instead of thelink --dir <dir>
case, and made the text more readable.Other examples in the same doc page use
foo
as the dependent andbar
as the dependency, therefore it's easier to understand the example if that convention is kept.Also, the case without
--dir
seems to be the "basic case" that is used more often, so for a beginner who's first reading about all of this it makes more sense to introduce that one first. The title of the section also suggests that we're primarily talking about the case without--dir
.When I first read the documentation, I misread the command and didn't notice the
--dir
argument, and then misunderstood how the command works, i.e. I first thought the roles of the packages would be reversed to what they actually are.I hope you find the updated example clearer as well, and if not feel free to close 🙂