mypy: Document existing config format

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by locating the existing configuration definitions represented by the TypedDict or dataclass. Compare the current formats, including inconsistencies and shorthands, and document them so future refactors and migration tools can rely on a complete description.

Written by the indexing model from the issue text.

Description

(For the weekends / later)

Document existing config formats - in either TypedDict or dataclass - including its inconsistencies / shorthands

It's critical for future refactors / configs (like in https://github.com/tmux-python/tmuxp/discussions/760) - and migration tools from the current format

Dominant language
Python
Stars
4.6k
Forks
248
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/tmuxp

All issues in tmux-python/tmuxp

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.