Unclear documatation: branch_remote_name
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.1k
- Forks
- 450
- Avg merge
- 11m
- Merged PRs (30d)
- 1
Description
branch_remote_name, branch_upstream_name, and branch_upstream_remote all take the name of a local branch and return some aspect of the branch's upstream, but it's not clear what the difference is.
i think a single example for each would go a long way towards making this more clear.
### Tasks
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for branch_remote_name, branch_upstream_name, and branch_upstream_remote in the Rust bindings. Add one example for each that makes their differences clear, then verify the documentation builds successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100