nus-se-script
commented
2 months ago Team's Response
Resolving the inconsistent naming syntax in the UG will also resolve this naming issue
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Inconsistent naming convention used in the UG and the command line program
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
A few examples. Conventions also says that square brackets are optional and angled brackets are compulsory, so in that sense it makes it hard to follow
[original: nus-cs2113-AY2324S2/pe-interim#2505] [original labels: severity.Medium type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Bug Chosen to address: the square brackets in the UG does not enclose the "/a" option in the list command
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The optional parameter is highlighted as [AMOUNT_TO_LIST] so it would make sense that "list /a" would be a valid input. However that is not the case as the example shows "list and "list /a 5" as valid. Instead including the"/a" in the optional field would make more sense.
list [/a AMOUNT_TO_LIST]