search

NiklasRosenstein / slap

Slap is a CLI to assist in the process for developing and releasing Python packages.
https://niklasrosenstein.github.io/slap/
Other
18 stars 11 forks source link

Improper documentation of some commands when doing `slap help` #100

Open qsantos opened 7 months ago

qsantos commented 7 months ago

Look for Base class for commands that should be aware of the active local virtual environment. Before the.


% slap help
Slap (version 1.11.0)

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the help command.
  -q, --quiet           Do not output any message.
  -V, --version         Display this application version.
      --ansi            Force ANSI output.
      --no-ansi         Disable ANSI output.
  -n, --no-interaction  Do not ask any interactive question.
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

Available commands:
  add                          Base class for commands that should be aware of the active local virtual environment. Before the
  check                        Run sanity checks on your Python project.
  help                         Displays help for a command.
  info                         Show info about the Slap application workspace and the loaded projects.
  init                         Bootstrap some files for a Python project.
  install                      Base class for commands that should be aware of the active local virtual environment. Before the
  link                         Base class for commands that should be aware of the active local virtual environment. Before the
  publish                      A wrapper to publish the Python project to a repository such as PyPI.
  release                      Create a new release of your Python package.
  run                          Base class for commands that should be aware of the active local virtual environment. Before the
  test                         Base class for commands that should be aware of the active local virtual environment. Before the
  venv                         Create, activate and remove virtual environments.

 changelog
  changelog add                Add an entry to the unreleased changelog via the CLI.
  changelog convert            Convert Slap's old YAML based changelogs to new style TOML changelogs.
  changelog diff assert-added  Base class for commands that perform changelog diffs.
  changelog diff pr update     Base class for commands that perform changelog diffs.
  changelog format             Format the changelog in the terminal or in Markdown format.

 report
  report dependencies          Base class for commands that should be aware of the active local virtual environment. Before the

 venv
  venv link                    Link executables from a global virtual environment.
``