search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

User Guide command summary table formatting #1129

Open nus-se-script opened 10 months ago

nus-se-script commented 10 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.

Formats and Examples could each have taken on their own columns in the tables in the command summary of the user guide.

image.png

Another trivial point would be that the format and examples would be the same for your general commands which don't have formats (help, exit, clear), which is why this might have made more sense.

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

jamesebond commented 10 months ago

Team's Response

We have tried the formatting of putting them in different columns as you have mentioned, however since the "examples" sentence is very long, it would make the table very small and the words hard to read and the formatting is not readable.

Duplicate status (if any):

--