search

SharlynLui / pe

0 stars 0 forks source link

Help sample output in User Guide not updated #12

Open SharlynLui opened 2 months ago

SharlynLui commented 2 months ago

This is the current output from "help"

image.png

This is the sample output of "help" in UG

image.png

nus-pe-script commented 2 months ago

Team's Response

Thanks for your bug report!

Good spot!

As this does not hinder the reader as help still outputs a help list as intended, we shall accept the bug as a DocumentationBug of severity.veryLow.

Textbook's guidelines:

image.png

The 'Original' Bug

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

Help function user guide sample output not updated

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.

help sample out put 1.png

help sample output 2.png

The sample output of the help function in the user guide seems to be an outdated version of the actual output

[original: nus-cs2113-AY2324S2/pe-interim#652] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Thanks for your bug report!

Good spot!

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]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/SharlynLui/pe/main/files/b782a025-1701-4aaf-be20-348e3ea4011c.png) **Why it is not very low:** I believe that the bug should not be of very low severity as it is not purely cosmetic such as grammar issues or extra padding. It affects the **usage** and **effectiveness** of the UG as documentation for the `help` command should demonstrate the feature of the command accurately but currently, it does not since it failed to show the correct output when using the command. **Why it should be low:** It is unlikely to affect the normal operation of the UG, however, it causes a minor inconvenience as readers expecting all the commands to be shown under `help` will be confused due to the missing commands and will have to look through the rest of the UG to check if the other commands exists / open the app to test the other commands to check if they are valid / open the app to check the actual display of help .