search

lightz96 / pe

0 stars 0 forks source link

Inconsistent UserGuide for addmods command #5

Open lightz96 opened 4 years ago

lightz96 commented 4 years ago

The addmods command section in the UG used link/NUSMODS_SHARE_LINK for the parameter

image.png

However, in the command summary, it used l/NUSMODS_SHARE_LINK

image.png

nus-pe-bot commented 4 years ago

Team's Response

The suffix should be link/, thank you for catching the typo!

We have changed the bug type to DocumentationBug as it would cause minor inconvenience to first-time users who starts off using the app by reading the command summary. The addmods section in the UG and the app itself does provide the correct format.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]

:question: Issue type

Team chose [type.DocumentationBug]. Originally [type.DocTypo].

Reason for disagreement: [replace this with your reason]