sethteo / pe

0 stars 0 forks source link

Standardisation of UG documentation #9

Open sethteo opened 2 months ago

sethteo commented 2 months ago

For the various methods most of them do not provide the success message of the method except for "sort n/" and "sort -a d/" perhaps all methods could provide the success message or all method do not provide the success message for better cohesiveness.

nus-pe-script commented 2 months ago

Team's Response

Both issues concern specification of success messages

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Inconsistent in stating success messages

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.


Screenshot 2024-04-19 at 5.30.10 PM.png

For some commands such as above, the expected success message is stated. For others, such information is omitted. The user might then be confused as to whether other commands also have success messages, and whether their in-app behaviour is correct.

It might be better to either state this information for all commands, or omit it entirely.


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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for pointing this out!

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]