seriouslia0 / pe

0 stars 0 forks source link

Edit command given in the tutorial does not work #3

Open seriouslia0 opened 1 year ago

seriouslia0 commented 1 year ago

Screenshot 2023-04-14 at 2.34.50 PM.png

Screenshot 2023-04-14 at 2.34.45 PM.png

I had copy pasted the edit command inside the user guide to see if it would work, however, it did not. It returned an error that i had incorrectly entered the command. Listing this as medium as some people would be able to see how it works, but at the worst case a bonehead may not be able to use this function entirely because the module code is the most important field. Since the functionality of the product differs from what is listed in the user guide, I will list this as a functionality bug

soc-pe-bot 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]

Edit command syntax inconsistent within the user guide.

image_2023-04-14_143842569.png

image_2023-04-14_143903819.png

The edit command syntax is inconsistent within the user guide. In the edit function examples, we can see the we do not need to give a module prefix "/m" in the command, however in the example in the tutorial, we need to. Since the correct command is eventually given and users can find out eventually after trial an error, i list the severity of this bug as low. However, it is not very low since some users who find that the tutorial does not work as intended might not be able to get the application working. I hope you understand.


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

Their Response to the 'Original' Bug

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

Nice catch, it was actually a typo. However, we will be reducing the severity to Low, because it was only a typo and the edit command feature under "Features" did specify the correct syntax, but we recognise this may affect users at the start, hence not Verylow.

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 type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree with this assessment. Picture the above situation, I am a new user, and I the moment I add the first module in I already begin to have issues using the application and have to "debug" how the application works myself. This may even dissuade the user from using it in the first place. In reference to the example provided in the quiz, at the worst cases, users might be unable to edit altogether. Of course they can always add and delete, so this doesn't make the feature unavailable to the user, but is a non trivial inconvenience nonetheless. Hence, I have marked this feature as "medium". ![Screenshot 2023-04-18 at 8.25.57 PM.png](https://raw.githubusercontent.com/seriouslia0/pe/main/files/481fcca4-8814-48e0-ae14-aa22971d0ebf.png)