Skip to content

Audit commands for extended descriptions and representational examples #2769

@danielbachhuber

Description

@danielbachhuber

We should make sure each command has an extended description with representational examples.

Here's what I mean by...

Extended descriptions

Instead of:

image

Expand the description to include at least a couple sentences about what the command does:

image

Representational examples

Instead of:

image

Include a representation of the command with its most likely output.

image

Work list

We'll need to do a full pass through all commands, and tick them off when they're done (script to generate list). Because the website documentation is generated from the codebase, the edits will need to be made to the PHPDoc for each command.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions