Ansel-Ch / pe

0 stars 0 forks source link

UG edit Format #9

Open Ansel-Ch opened 4 days ago

Ansel-Ch commented 4 days ago

The ellipses might be misleading

To Reproduce

Input an edit command with more than 1 u/ prefix

Expected behavior

According to the UG, we can have 0 or more university prefixes as suggested by the "..." notation that follows the brackets. However, when I tried doing that, I was met with an error message. Perhaps this could be considered a documentation flaw as well because users are only allowed to have multiple Interests and Tags but this is not clearly defined in the UG.

Severity

Medium

Reference – cs2103 bug severity levels

Screenshots

image.png

image.png

Desktop

OS: Microsoft Windows Resolution: 2560 X 1440 Version: Windows 11 Home 24H2

nus-se-bot commented 1 day ago

Team's Response

The "..." notation should be in the bracket to indicate that the field will accept multiple values. In this case, the "..." is out side of the brackets thus does not mean that the user can input multiple universities.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png Apologies but this line in your UG contradicts your response.

image.png Here is that same formatting used in the add command to ascertain the consistency of this notation.

In my opinion, this is a response.Accepted as it is a simple fix perhaps either in the code or the documentation.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Perhaps I will provide a simple analogy. Similar to how as a Java programmer you would often refer to the Java documentation when unfamiliar with commands, you would follow the method signatures outlined by the documentation. Drawing parallel to that, due to the nature of the edit command, with a non-exhaustive number of possible arguments, it is impossible to rely solely on the limited number of examples provided in the UG. Hence, a user would naturally be inclined to follow the format. This will result in them encountering occasional functionality issues when trying to input multiple university arguments. Moreover, perhaps your team originally wanted to allow multiple university arguments, as several individuals could have taken their undergraduate and postgraduate courses at different universities. Hence, in my limited-time testing, I might not be entirely aware of the intended edit feature, which is why this is considered a functionality bug to me as the suggested argument format in the UG does not align with the actual implementation in the application. `severity.Medium` : A flaw that causes occasional inconvenience to some users, but they can continue to use the product.