Confusing explanation of index vs id in the docs

Open
#309 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

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.

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.

Dominant language
Python
Stars
1.2k
Forks
127
Avg merge
2h 13m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tmux-python/libtmux

All issues in tmux-python/libtmux

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.