Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Command List rendering #188

Open
Nova38 opened this issue Nov 5, 2024 · 0 comments
Open

Add Command List rendering #188

Nova38 opened this issue Nov 5, 2024 · 0 comments

Comments

@Nova38
Copy link
Contributor

Nova38 commented Nov 5, 2024

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".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant