Rachelcoll / pe

0 stars 0 forks source link

Command example in UG has format error when copy to the app #5

Open Rachelcoll opened 1 week ago

Rachelcoll commented 1 week ago

Directly copy the command from the UG pdf generates this error due to the disappear of white space before /email and /subject:

image.png

This may because the newline in pdf file diminishes the whitespace:

image.png

This can be quite inconvenient for first time users who directly copies from user guide. I stuck here for a while to find out why i copy the standard command from ug but still cause an error until I find the whitespace issue.

nus-se-bot commented 1 week ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Invalid example for "Adding Teacher" section in UG

The provided example command in the screenshot below yielded an "invalid command" error, because of the typo where there was no space added between 95673211 and /email elizchua. Was quite difficult to spot and can hinder the user's understanding of using the add teacher command especially considering how it's the first and only example for the "Adding Teacher section".

teacher /name Elizabeth Chua /gender female /contact 95673211/email elizchua@yahoo.com /address Blk 30 Lorong 3 Serangoon Gardens, #07-18/subject English /classes 5A, 8C

Screenshot 2024-11-15 at 5.23.54 PM.png

Screenshot 2024-11-15 at 5.23.34 PM.png


[original: nus-cs2103-AY2425S1/pe-interim#3626] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

image.png

image.png

According to these instructions, this is not a bug but a user error.

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`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/Rachelcoll/pe/main/files/6aaf7353-8802-46d5-9b8e-5dbe962842c2.png) According to the course website, whitespace issue caused by pdf file can be considered as bug if it hinders the user. It says "Formatting issues can hinder the reader in the sense they can slow down the reader or require the reader to put more effort than necessary", and clearly this is a PDF formatting issue as the reader needs to check for quite a long time and remove missing whitespace to make the command execute correctly. ![image.png](https://raw.githubusercontent.com/Rachelcoll/pe/main/files/8622c269-2565-4d7b-b380-cbbf0eda62f8.png) According to requirements in course website, allowing user to copy examples should be a basic expectation of the pdf file, so this issue should be considered as a bug and fix. Also it turns out it is more a formatting error instead of my pdf reader error, cause the same command in command summary part of UG can be copied correctly. ![image.png](https://raw.githubusercontent.com/Rachelcoll/pe/main/files/1c14c659-28a6-448e-8ecb-076067f24e1c.png)
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]