nus-pe-bot
commented
7 months ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
In-app help for new and edit not specifying order
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.
Help command for new and edit should mention the need for specific parameters order.
[original: nus-cs2113-AY2324S2/pe-interim#144] [original labels: type.FeatureFlaw severity.VeryLow]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Hi there, thank you for your report.
As you may have noticed, the need for the parameters to be in the specified order is mentioned in the User Guide.
It was an intentional choice for these details to be omitted from the in-app help page for a few reasons: 1) The help page would be overly cluttered if we try to include every specific detail on how to use the commands. Just imagine how long the help page for individual commands would be if we included the entire "Notes about the Command Format" section (shown in screenshot above) and other nitty gritty details on every execution of the help command.
2) This issue is unlikely to hinder most users. In this case, we prioritised having a concise help page for our application over catering to the small handful of users that may not know to follow the order of the flags.
3) Even if the user does input the flags in the wrong order, there is sufficient guidance within the application to correct the user. For example, if the user inputs a new product using the flags in the wrong order, StockPal will inform the user that the
n/flag should come first. A sample output of this example is shown below.>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Enter a command: new q/10 n/testing <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< n/ flag cannot be detected! Ensure n/ flag is entered immediately after 'new', using n/<Name> >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>4) If the user is still confused, they should then refer to the User Guide for guidance.
We hope this helps you to understand our design choices. Nevertheless, we appreciate you bringing up your concerns. Thanks!
Regards, StockPal 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]
## :question: Issue response Team chose [`response.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.DocumentationBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Your UG's features list states this, but the user should also be informed of this at the commands' instructions too.
In the UG's instructions for new and edit commands, there is no mention of specific ordering.