tldr-pages / tldr-pages/tldr-python-client
[Feature] Add notes support
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 749
- Forks
- 117
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to be able to add custom notes to certain commands, which could then be displayed at the end of their output.
For example, there's a complex command I sometimes need to use but always forget, and it would be great to be able to specify it in tldr so I could simply use tldr {command} to display it.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are identified in the issue. Start by locating the CLI command lookup and output-rendering entry points, then determine how custom notes would be stored and associated with commands; done means a user can define a note and see it at the end of that command's tldr output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100