pimutils/khal

Improve shell completions

Open

#1142 opened on Jun 24, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (2,349 stars) (191 forks)batch import
help wantedtype: enhancement

Description

Click supports providing more information on parameters, so that the generated shell completion files are more helpful.

Together with #1141 this supersedes #1034, #1062 and #937

Contributor guide

Tech stack
python
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonClick libraryShell completions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how Click provides parameter metadata for shell completions, referencing the linked issue #1141. Look at the existing completion generation code in Khal, likely in a file related to CLI setup, and identify where Click's parameter info can be added to improve completions. Review the Click documentation on shell completion and see how other projects have enhanced their completions.