Skip to content

docs: remove duplicate defaults in help

Sebastian Gumprich requested to merge rndmh3ro/cli:fix_help_doc into main

Description

Found some duplicate help messages.

Related Issues

Resolves #1180 (closed)

How has this been tested?

Manually by looking at the diff.

Screenshots (if appropriate):

Before:

> glab ci list -h
Get the list of CI pipelines

USAGE
  glab ci list [flags]

FLAGS
  -o, --orderBy string   Order pipeline by <string>
  -p, --page int         Page number (default 1)
  -P, --per-page int     Number of items to list per page. (default 30) (default 30)
      --sort string      Sort pipeline by {asc|desc}. (Defaults to desc) (default "desc")
  -s, --status string    Get pipeline with status: {running|pending|success|failed|canceled|skipped|created|manual}

INHERITED FLAGS
      --help              Show help for command
  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL

EXAMPLES
  glab ci list
  glab ci list --status=failed

LEARN MORE
  Use 'glab <command> <subcommand> --help' for more information about a command.

After:

> ~/dev/glab/bin/glab ci list -h
Get the list of CI/CD pipelines

USAGE
  glab ci list [flags]

FLAGS
  -o, --orderBy string   Order pipeline by <string>
  -p, --page int         Page number (default 1)
  -P, --per-page int     Number of items to list per page. (default 30)
      --sort string      Sort pipeline by {asc|desc}. (default "desc")
  -s, --status string    Get pipeline with status: {running|pending|success|failed|canceled|skipped|created|manual}

INHERITED FLAGS
      --help              Show help for command
  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL

EXAMPLES
  glab ci list
  glab ci list --status=failed

LEARN MORE
  Use 'glab <command> <subcommand> --help' for more information about a command.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation
  • Chore (Related to CI or Packaging to platforms)
Edited by Sebastian Gumprich

Merge request reports