search

CloudHill / pe

0 stars 0 forks source link

Invalid format when trying to copy examples from UG #8

Open CloudHill opened 1 year ago

CloudHill commented 1 year ago

For example, when trying to copy the example from the add feature

image.png

Notice the missing space in between a/Toma/Adele and the unknown character at the end

image.png

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Sample listing provided cannot be added

image.png

The example command to add a new listing to GoodMatch, which is add t/Cool job title d/Informative job description a/John p/Samp/Linkedin gives an error.

[original: nus-cs2103-AY2223S2/pe-interim#4187] [original labels: severity.Low type.FunctionalityBug]

Their Response to the 'Original' Bug

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

There should be a space between "p/Sam" and "p/Linkedin" which is causing the command to be invalid. It is mentioned in the UG that there should be spaces between flags which is causing the command to be invalid. Also, as said in the error message, platform names should only be alpha numeric so the "/" character is causing a problem. The command cannot be copied from the UG due to pdf conversion reasons which cannot be helped.

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: I believe that the original bug is referencing the example given from the application itself (notice the missing space before p/LinkedIn):

image.png

While my bug references the example given from the User Guide:

image.png

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** There are certainly ways to fix this issue, for example using a code block instead with a `white-space: pre-wrap;` style applied to it. I would understand if the developer team doesn't feel that this is as important and marks this as `NotInScope`. However, I don't believe it should be rejected as it affects how most people would use a guide: copying and pasting commands.
## :question: Issue type Team chose [`type.FunctionalityBug`] Originally [`type.DocumentationBug`] - [x] I disagree **Reason for disagreement:** Regardless of whether team believes it is under their control, this still falls under `type.DocumentationBug` as it is an issue relating with the User Guide