nus-pe-script
commented
1 year ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
User Guide: Incomplete Add command format
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.
The format provided in theaddcommand section does not include tags. Even though later in the points it is mentioned, it is better to have an overview especially when referencing to type out a command.Since the notes section in Page 3 already mentioned "optional items" in square brackets, it can be utilised in the format for the tags.
Image:
[original: nus-cs2103-AY2223S2/pe-interim#446] [original labels: severity.VeryLow type.DocumentationBug]
Their Response to the 'Original' Bug
[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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
I think it would be better to add the optional tag field in the command format. This would align the 'Notes about the command format' section at the very start so that they can indicate that the tag field is optional and that it can accept multiple values.
Upon scrolling further, the command summary then includes the tag field whereas the earlier section does not.