Skip to content

Add examples of usage to --help commandΒ #1142

Closed

Description

@hyzyla

What's the problem this feature will solve?

I constantly forget which parameters to use when compiling the requirements. My most common use cases:

  1. Upgrade packages
  2. Compile requirements in requirements folder
  3. Dry run

Describe the solution you'd like

Add examples of the most common use cases of pip-compile for --help comand. For example, dramatiq has few examples of usage under a list of parameters:

...
  --version             show program's version number and exit
  --verbose, -v         turn on verbose log output

examples:
  # Run dramatiq workers with actors defined in `./some_module.py`.
  $ dramatiq some_module

  # Run with a broker named "redis_broker" defined in "some_module".
  $ dramatiq some_module:redis_broker
....

Alternative Solutions

Read documentation, review all flags every time, learn all parameters

Activity

  1. atugushev commented on May 11, 2020

    @atugushev
    Contributor

    Hello @hyzyla,

    Thanks for bringing this up! Yes, we need proper documentation. Unfortunately, --help becomes a mess and still growing. Any help is highly welcomed and encouraged.

  2. webknjaz commented on Jul 8, 2023

    @webknjaz
    Member

    FWIW, cURL has a categorized help like curl --help all with curl --help being short.

    https://clig.dev/#help documents the complex help sections very well, offering good advice. We should follow it whenever possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation relatedgood first issueA good item for first time contributors to work onhelp wantedRequest help from the community

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions