wanjuin / pe

0 stars 0 forks source link

Incorrect User Guide seedetail format. #20

Open wanjuin opened 1 year ago

wanjuin commented 1 year ago

the correct format should be :

seedetail movie [enter] movie_name [enter] movie_index

image.png

nus-se-script commented 1 year ago

Team's Response

截圖 2023-04-16 上午8.58.36.png

The reason why it is written as <movie_index> instead of movie index is shown in the above picture (a part of user guide). First, the user is not supposed to enter the word movie index. In addition, there might be up to 5 indices (1-5) that the user can enter, so therefore it is put as <movie_index>.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think the team has misunderstood my comments regarding the Incorrect User Guide seedetail Format. I am not commenting on the difference between <movie index> and movie_index. I am commenting on how the seedetail movie Format should be seedetail movie [Enter] <movie name> [Enter] <movie_index>. The team has missed the input of parameter <movie name>. In the User Guide, only <movie index> is indicated as a required parameter for seedetail movie.

As shown in the image below, both <movie name> and <mmovie index> are required as a parameter for the command seedetail movie.

image.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** severity.Medium. Understanding that this flaw will not cause major problems to user, this could be labelled as a medium issue instead. I regard this as a high severity functionality bug or documentation bug in the first place, as I am testing this against the User Guide. The required parameter by the program of this command (`seedetail movie`) is not following the Format of the User Guide. However, instead of severity.High, I would actually consider it as severity.Medium. This is because, in the UI interface it is actually stated that "Please enter the movie name..." (as shown in the image below) . But I would still regard this as a severity.Medium functionality bug / documentation bug as this was first tested against the User Guide and it is important for the Format of command inside User Guide to match with what is actually intended in the actual program. Hence, I think that this bug is a quite serious problem especially for a first time user. ![image.png](https://raw.githubusercontent.com/wanjuin/pe/main/files/721d39e1-09cd-40b8-b652-23695aac61fe.png) Furthermore, this should not be severity.veryLow, this is because severity.veryLow should only be used for cosmetic problem whereas this issue is not cosmetic related. Hence, this should not be severity.veryLow. ![image.png](https://raw.githubusercontent.com/wanjuin/pe/main/files/ed45ca7f-d96d-4421-b358-567a86d5425b.png)