tmux-python / tmux-python/libtmux

Documentation: how to use internal libtmux logging

Open Beginner friendly
#744 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In official project documentation at https://libtmux.git-pull.com/, nothing about logging appears to be mentioned anywhere. Since libtmux doesn't work on Windows in an msys2 (git bash) shell, logging would be very helpful to see what may be going wrong. However, the only way to use the logging feature is to study the code and infer a strategy for configuration. Please document this feature.

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 at the official documentation site, https://libtmux.git-pull.com/, and inspect the existing organization for a suitable location. Read the libtmux logging implementation to determine the supported configuration approach, then document how users can enable and use logging, including its value for diagnosing the reported Windows msys2 issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.