Skip to content

Inconsistent Information on switch Command in User Guide #8

Description

@yu7ong

Description:
The User Guide contains contradictory information about the switch command. In the parameters table, it indicates that the PROFILE parameter is required for the switch command. However, in the examples, it suggests that the command can be used without specifying a profile name to list all available profiles, if they exist. This inconsistency may lead to confusion about the command’s functionality and requirements.

image.png

image.png

Suggested Improvement:

  • Update the Compulsory? column in the parameter table for the PROFILE parameter to clarify its requirement status.
  • Ensure that the example and table information align, stating explicitly if switch alone will list profiles.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions