Skip to content

feat: add examples to --help output #148

@angeloashmore

Description

@angeloashmore

Description

Commands with non-obvious flag combinations would benefit from an EXAMPLES section in their --help output. The buildCommandHelp() system already supports custom sections, so this is adding content to individual commands.

Priority candidates:

  • field add rich-text--allow syntax
  • field add content-relationship--custom-type, --tag, --field interaction
  • field add select--option repeating
  • type create--format page vs --format custom with --single
  • slice connect — which args go where

Simple commands like type view, locale add, repo create probably don't need examples.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions