Skip to content

Add Command List rendering  #188

Description

@Nova38

This would render just the spoken command and not the docstring or description. This could either be in the form of a list or as an option to the command-table directive that only renders the first column of the table. If the latter it could also be implemented so that it could be toggleable.

There are a few reasons this pattern might be desirable the first is that it would allow for removing visual noise and saving space for list of commands who's action is evident from the spoken command. This would be useful in creating 'cheatsheet' like documentation, in combination with sphinx-design etc..., a good list this could be used for is the editor actions/vscode.

The other main reason is that it would also allow for displaying the list without the same discrimination being printed for most of the items in a list such Such as: jetbrain where most of them just say "Send a command to Jetbrains product".

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions