jonas / jonas/tig

Feature Request: Ability to add comments into help view.

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

Nobody has claimed this yet.

Dominant language
C
Stars
13.3k
Forks
669
PR merge metrics
No merged PRs in 30d

Description

Feature Request : Ability to add comments into the help view.

Reason: There is no way to provide comments for custom keybinds in the help view.

image

Attempt: I tried to add hacky comments using shell in-line execution, but the # character still gets exposed to .tigrc parser, and stripped away.

image

Contributor guide

No contributing guide indexed for this repository

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 tracing how .tigrc keybindings are parsed and how the help view renders custom keybinds. Determine how comments should be represented without exposing the # character to the parser, then verify that comments appear correctly in the help view while existing keybindings continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.