search

peterXGD / pe

0 stars 0 forks source link

Documentation example not working for product #1

Open peterXGD opened 6 months ago

peterXGD commented 6 months ago

When using UG example code add -fn Javier -ln Tan -p 98749874 -s m -pr 10.5 -a 123 Street -b posb 420053040, the code does not work as there should be a space betwen 'posb' and '420053040;' and I am greeted with a message that says about bank info. Screenshot 2024-04-19 at 4.16.49 PM.png

nus-pe-script commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Codes posted in UG, if written on 2 lines, often lacks a space when there should be one.

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.

Code in the UG, that are written in 2 lines, often lacks a necessary space between them(like a space in add -fn FIRST_NAME -ln LAST_NAME) which becomes (add -fn FIRST_NAME-ln LAST_NAME`) when i copy it to the command line. (This happens repeatedly throughout the UG)

This is troublesome as for people learning to use the app, especially for the targeted user group who want to manage contacts and payrolls might not be too knowledgable to know if they need to input an extra space when learning and can this hinder the effectiveness of the UG for first time users as a learning tool. Screenshot 2024-04-19 at 5.21.44 PM.png

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

Their Response to the 'Original' Bug

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

image.png

It has been stated in our UG that this could be an issue to be wary of.

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 response Team chose [`response.Rejected`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.VeryLow`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]