tmux-python / tmux-python/libtmux
Confusing explanation of index vs id in the docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 127
- Avg merge
- 2h 13m
- Merged PRs (30d)
- 1
Description
At https://libtmux.git-pull.com/about.html one reads the following
What is a {pane,window}_index vs a {pane,window,session}_id?
Pane index refers to the order of a pane on the screen.
Window index refers to the # of the window in the session.
It is hard to read.
The first thing is I took {x,y} automatically to mean a pair and {x,y,z} to mean a triple.
The second thing is you mention _index vs _id and then you refer to both with index? After reading this I still do not now which is which.
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
Open about.html and read the section titled “What is a {pane,window}_index vs a {pane,window,session}_id?”. Rewrite it so the brace notation and the distinction between index and id are unambiguous, then confirm the rendered documentation clearly explains each term.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100