Skip to content

Update help documentation to pass option in recommended formatΒ #3824

@AdmiringWorm

Description

@AdmiringWorm

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

No response

Describe The Solution. Why is it needed?

We should look over all of the help documentation and update every mention of how options have been passed to use our recommended practices.

Currently our help documentation uses the format --<NAME> <VALUE>, but we are recommended that users pass options with the format --<NAME>="'<VALUE>'", we should update our help documentation to make use of this formatting.

Additional Context

No response

Related Issues

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    0 - TriagingIssue is accepted, but a milestone has yet to be added for the issue.DocumentationIssues for changes that only need to change documentation.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions