search

ZhangWenyue3325 / pe

0 stars 0 forks source link

Usage of -h affects the normal usage of take and untake feature #6

Open ZhangWenyue3325 opened 4 months ago

ZhangWenyue3325 commented 4 months ago

image.png

When '-h' is entered to print the help message, the valid command of marking medication 2 as taken becomes meaningless. This is not specified in UG.

soc-pe-bot commented 4 months ago

Team's Response

Thank you for pointing this out.

I would like to clarify that the purpose of using the -h flag is so that the user can see if they have the right arguments specified and verify that they have all the necessary arguments before proceeding. By removing the -h flag, they will be able to continue running the command as per normal.

take ... -h prints the help message as per specified in the Options portion in both the UG and the program itself. image.png image.png

It is also stated in the UG that the expected output is as such and anything else will indicate the command not running successfully (Be it an error message or help message):

image.png

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Confusing -h in Every Command Description

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.

Including "-h" in one of the parameters for each command is confusing when retyping (i.e. modify and modify -h has the same functionality, just makes the user confused whether to input -h or not).

Screenshot 2024-04-19 172919.png

Screenshot 2024-04-19 172931.png

[original: nus-cs2113-AY2324S2/pe-interim#1108] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

While modify and modify -h may output the same message, the intention are as such:

  • Command on its own (modify, add, delete ...): Allows user to immediately get a breakdown of what to provide when using the command (Initial use of the command)
  • Command with the -h flag (modify ... -h, add -h, delete ..... -h): Allows user to get a breakdown of what ELSE to provide while in the middle of typing the command, else the command will error out and notify the user of the missing argument (Midway typing of the full command with its arguments)

Attached below is an example of the intended usage of this feature: image.png

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 response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** Thank you for your explanation! However, I do believe that this leads to confusion and it needs to be specifically stated in UG that when -h is entered, the commands will not be executed.
## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FeatureFlaw`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]