search

vimalapugazhan / pe

0 stars 0 forks source link

List command does not work as intended #4

Open vimalapugazhan opened 5 months ago

vimalapugazhan commented 5 months ago

image.png

image.png

UG and Error messages say that amount to list is optional however when inputting "list /a" the error is thrown.

nus-pe-bot commented 5 months ago

Team's Response

This is related to documentation bugs in the help command and the UG where the format for the list command was not specified clearly

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.

image.png

image.png

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)

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.Medium`] Originally [`severity.High`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]