search

ling-ui / pe

0 stars 0 forks source link

Add command example in UG not working due to missing space #1

Open ling-ui opened 1 year ago

ling-ui commented 1 year ago

image.png

image.png

When copying the first input example into the input bar, the command fails to work due to the missing space between Human and Resources.

nus-se-bot commented 1 year ago

Team's Response

Both issues are regarding incorrect example due to spacing typo.

The 'Original' Bug

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

Add command example in Command summary not working due to missing space

image.png

There is a missing space between the email field and the flag for the address (between .com and a/...) so copying this input into the app does not work.

[original: nus-cs2103-AY2223S1/pe-interim#3760] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Hi there! Thanks so much for the report.

We accept that there is a missing space in the provided example, however we do not agree that it is a "Medium" severity, as it is a spacing typo and does not affect the app usage.

Once again, thank you so much for informing us regarding the error.

Cheers,
Coydir
HR is hard, Coydir is easy
(est. 2022)

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: While the typo made is the same (missing space), the missing space occurs at different parts of the command. In this case, it is a missing space in the input of a field. In the other issue raised, it is a missing space between an input and a flag. Both examples are hence invalid for different reasons in terms of command format. These are also separate examples in separate parts of the UG.

:question: Issue severity

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

Reason for disagreement: I do agree that perhaps this typo might not affect readers that do not refer to the UG to use the app, hence it does not stand at "Medium" severity. However, I do think that it should at least be of "Low" severity, as this is a typo in an example that readers might refer to to learn how to use the app. Due to the typo, usage of the app would be hindered if the example is followed by the user. Hence, this is not merely a cosmetic issue.