search

yap-zong-xin / pe

0 stars 0 forks source link

Unnecessary splitting of command features into smaller parts #9

Open yap-zong-xin opened 4 months ago

yap-zong-xin commented 4 months ago

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

nus-se-bot commented 4 months ago

Team's Response

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

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: [replace this with your explanation]