search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Unnecessary splitting of command features into smaller parts #287

Open nus-se-script opened 5 months ago

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

Description

Although your UG is very detailed, I personally feel that by explaining every single detail and showing the actual and expected output of even a very simple changes (splitting the command into smaller sub parts) made your UG hard to read.

For example, for the edit portion, the example for tags can be combined with the first one, and it will still be effective and convey how tags work in edit.

Both seems very similar: image.png image.png

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

brennalaurentan commented 4 months ago

Team's Response

Accepted as a bug, but of VeryLow severity as it is a purely cosmetic documentation bug.

Duplicate status (if any):

--