search

ongweijie7 / pe

0 stars 0 forks source link

Commands are not in grey background #19

Open ongweijie7 opened 1 year ago

ongweijie7 commented 1 year ago

Screenshot 2023-04-14 at 3.31.16 PM.png

Commands should be shown in grey background as mentioned in the UG earlier.

soc-se-bot commented 1 year ago

Team's Response

Duplicate

The 'Original' Bug

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

Commands are not in grey background for list_alarms

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 2023-04-14 at 3.31.51 PM.png

Commands should be shown in grey background as mentioned in the UG earlier.

[original: nus-cs2103-AY2223S2/pe-interim#2983] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

image.png

The user guide states that words in this grey background are used to denote commands, but it does not specify that every command will have a grey background

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: Screenshot 2023-04-18 at 2.58.33 PM.png

This is an independently fixable bug.

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** ![Screenshot 2023-04-18 at 1.33.26 PM.png](https://raw.githubusercontent.com/ongweijie7/pe/main/files/d3228915-6ed5-4270-a549-b160c56c12c8.png) I believe there should be consistency across all the example given in the UG. If there is going to be `grey` background for any of the commands given in the examples, this should be maintained throughout. It should not be a case where this `grey` background appears randomly whenever the team chooses to because that would be confusing for a user. This is especially so when most beginner users would reference example commands when first learning how to use the application. Hence, this is a valid bug.