Open kaijie0102 opened 10 months ago
As suggested, the command summary is meant to provide a brief summary of the various commands that we have implemented, thus it does not 100% correspond to the detailed commands as we tried to summarise them in such a way for the user to be able to make the most out of a simple bullet-point listing. Thus in the command summary, all commands are included, but their examples differ as we tried to give a wide variety of different approaches as inputs. For the full detailed requirements of each command, they are listed specifically under each command in the UG.
[The team marked this bug as a duplicate of the following bug]
Command Summary does not contains all parameters supported
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.
Expected:
- Command Summary contains all parameters that a command supports.
Actual:
- Optional parameters are not clearly shown, or even ignored.
Screenshots:
[original: nus-cs2113-AY2324S1/pe-interim#892] [original labels: severity.Low type.DocumentationBug]
[This is the team's response to the above 'original' bug]
No details provided by team.
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: I agree that it is a duplicate, but I do not agree for it to be rejected
Rubrics mention that features' "descriptions should match the product precisely". I feel that leaving out parameters of functions does not make the description precise