search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

List and change theme command summaries can include both parameters #1499

Open nus-se-script opened 11 months ago

nus-se-script commented 11 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

For the commands list and theme, which have only 2 possible parameters, it may be more meaningful to list both parameters (i.e. list both list -pa + list -sp, and theme light + theme dark)

image.png

This will be more complete and let users see the full functionality at a glance.

[original: nus-cs2103-AY2324S1/pe-interim#1220] [original labels: severity.Low type.DocumentationBug]

Gavino3o commented 11 months ago

Team's Response

This is not a flaw in documentation as the current user guide is still correct, and users are not hindered. Also, Future iterations plan to add many more possibilities for the theme command , which would make listing all the possibilities messy.

Duplicate status (if any):

--