GiselleTan / pe

0 stars 0 forks source link

Extra spaces required when typing out commands was not made clear in User Guide #13

Open GiselleTan opened 2 months ago

GiselleTan commented 2 months ago

When I was following out the commands in the user guide and tried typing it in myself, I often got errors. However, it was not mentioned anywhere in the guide that there are spaces before and after parameters in the commands.

Steps to reproduce: Enter the following command: /edit-person; name :J1; field:{address:PoochieStreet 25}

Screenshot 2024-04-19 at 5.02.38 PM.png

nus-pe-bot commented 2 months ago

Team's Response

image.png

It is actually mentioned in a special box in the start of the features section in our UG, as seen in the screenshot above, that our commands are space sensitive and spaces before prefixes are required. We have explicitly warned the users that are commands are space sensitive and it can be seen clearly from all our examples of the edit command that the fields have spaces before and after parameters in the commands.

In your specific case, if you were to look add the example provided for edit-person, there is clearly a space before the value of name, between field and colon, between { and address, and between : and value of address. Additionally, the white space that is not rendered by Jekyll is not considered a bug, as seen in the TP rubrics below. telegram-cloud-photo-size-5-6138804929951809362-y.jpg/var/folders/tg/yrcwyrrj2_qc1tf0swypgctw0000gn/T/ru.keepcoder.Telegram/telegram-cloud-photo-size-5-6138804929951809362-y.jpg

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: > Additionally, the white space that is not rendered by Jekyll is not considered a bug, as seen in the TP rubrics below.

Yes, in the TP rubrics provided, it states that the white spaces are "Not counted a bug unless it hinders the reader". I would say that it does hinder the reader as they have to spend extra effort to fix the spacing.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]