microsoft / microsoft/knack

Help file parameter entries are very strict towards the allowed entry name.

Open
#85 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/help type/enhancement
Dominant language
Python
Stars
358
Forks
101
PR merge metrics
No merged PRs in 30d

Description

Now, if you have the options, --source and -s, you need to enter the parameter as --source -s.
NOT: --source or -s or -s --source.

We might want to consider making this more lenient.

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 by tracing how help-file parameter entries are parsed and locating the existing tests for option-name handling; the issue does not name a file or test. Reproduce the documented --source/-s examples, then add coverage for each accepted ordering and confirm help generation treats the aliases leniently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.