tmux-python / tmux-python/libtmux

Options: Typed structures

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

Nobody has claimed this yet.

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

Description

Can be dataclass.

  • ServerOption
  • SessionOption
  • WindowOption
  • PaneOption
  • Option = ServerOption + SessionOption + WindowOption + PaneOption

Consider pydantic, for its field's:

  • alias: for marshalling automatic-rename to automatic_rename
  • description: for documenting option purpose

See also

  • #516

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.

Research direction

Start by reviewing the related issue #516 and the linked Python dataclasses and Pydantic documentation. Clarify the preferred approach and scope before locating the option definitions; the work is done when the four typed structures and combined Option have agreed alias and description behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.