view.rs: clarify some internal function docstrings #2962
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
ilyagr
changed the title
Mostly, I was a bit confused that some of these functions return a `TrackingRefPair` but don't seem to take into account whether the remote branch is being tracked or not.
ilyagr
added a commit
to ilyagr/jj
that referenced
this pull request
Feb 7, 2024
As discussed in jj-vcs#2962 (comment), the previous name is confusing since the struct is used for pairs where the remote branch is not tracked by the local branch.
ilyagr
added a commit
to ilyagr/jj
that referenced
this pull request
Feb 7, 2024
As discussed in jj-vcs#2962 (comment), the previous name is confusing since the struct is used for pairs where the remote branch is not tracked by the local branch.
yuja
reviewed
Feb 7, 2024
| @@ -212,8 +214,13 @@ impl View { | |||
| } | |||
| } | |||
|
|
|||
| /// Iterates local/remote branch `(name, remote_ref)`s of the specified | |||
| /// remote in lexicographical order. | |||
| /// Iterates over `(name, {local_ref, remote_ref})`s for every branch | |||
There was a problem hiding this comment.
nit: local_ref -> local_target
| /// Iterates local/remote branch `(name, remote_ref)`s of the specified | ||
| /// remote, matching the given branch name pattern. Entries are sorted by | ||
| /// `name`. | ||
| /// Iterates over `(name, TrackingRefPair {local_ref, remote_ref})`s for |
ilyagr
added a commit
to ilyagr/jj
that referenced
this pull request
Feb 7, 2024
As discussed in jj-vcs#2962 (comment), the previous name is confusing since the struct is used for pairs where the remote branch is not tracked by the local branch.
ilyagr
added a commit
that referenced
this pull request
Feb 8, 2024
As discussed in #2962 (comment), the previous name is confusing since the struct is used for pairs where the remote branch is not tracked by the local branch.
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.
Mostly, I was a bit confused that some of these functions return a
TrackingRefPairbut don't seem to take into account whether the remote branch is being tracked or not.This fell out of #2935.
Please let me know if the new version is not clearer, or especially if I misunderstood.