search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Missing examples in command summary table #682

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 table and bar features, we are only giving an example for how to use it with d/YEAR, BUT NOT prefix/. Since this table is meant as a one-stop review page, it would be good if we could have examples for both use cases so that readers don't have to scroll up to the features section to find it.

image.png

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

laurenlim2112 commented 11 months ago

Team's Response

The examples in the command summary are not meant to be representative of all possible commands. Our team feels that including examples for all types of commands (e.g. table s/, table g/ etc) would make the summary section too long and repetitive, defeating the purpose of it being a summary. All examples have already been provided in the section regarding the table command.

Duplicate status (if any):

--