Open nus-pe-bot opened 5 months ago
Our user guide is already 16 pages long, which is quite a lot for any user to read. We felt that adding more cases than necessary would clutter the user guide, making it less readable. Hence, we decided to only include one or two examples for each command in the user guide, specifically choosing examples that we felt would be most used by the user.
Duplicate of #2137
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 example, for the "update" command, the output examples in the UG are only "update n/Milk q/200 p/10 e/15-06-2113" and "update n/Milk q/50 p/9.99 e/nil". it would be good if the user gets to see at least one output where not all three of the q/, p/ and e/ parameters are present since they are optional.
[original: nus-cs2113-AY2324S2/pe-interim#1687] [original labels: severity.Low type.DocumentationBug]