PyCQA / PyCQA/isort

Show blank isort output at top of help command

Open
#1,938 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7k
Forks
687
Avg merge
4h 56m
Merged PRs (30d)
2

Description

While reading the documentation, I found that isort shows some common examples if called without any arguments. However, as a new user, I called isort via isort --help. It would be beneficial if these examples were included in the help text, preferably in the first few lines.

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 at the CLI entry point for isort --help and compare its help text with the examples shown when isort is called without arguments. Determine where the examples are assembled, then include them near the beginning of the help output and verify that the help command displays them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.