search

rageqqq / pe

0 stars 0 forks source link

Unclear information provided about the correct inputs #11

Open rageqqq opened 3 years ago

rageqqq commented 3 years ago

image.png

The UG mentions that the user can follow one of these formats for the add lsn command. However, there is a contradicting statement below.

image.png

The screenshot shows that any of the inputs except the lesson type can be skipped.

nus-pe-bot commented 3 years ago

Team's Response

Made a duplicate of #957 as both are about how the format of lesson command and "skipping" is presented.

As shown in the example, "skipping" means leaving the field blank. You still have to follow one of the formats above for the command, specifically the usage of semicolon and the order of the fields.

The 'Original' Bug

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

Clearer information can be provided about whether an argument is compulsory or optional

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

The UG states that the lesson type for the "add lsn" command cannot be skipped. However, all the arguments are shown in the <> brackets. This can make it difficult for a user to know whether an argument is compulsory. One suggestion can be using different brackets to help users distinguish between compulsory and optional arguments

[original: nus-cs2113-AY2021S2/pe-interim#957] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

In the tips section below, we mentioned that the "lesson type" cannot be skipped, while the others can be skipped.

If you are coming from the point that it can be made easier to read, this is subjective so we think this seems to be a suggestion and not a bug?

From our point of view, adding it to the format may lead to some users misinterpreting what it means to be optional, and end up inputting the command wrongly. Hence, we only have it in the tips section so that only readers who pay more attention and are more familiar with the product would use it. Being able to skip is a bonus trick for advanced users rather than something essential to the 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 reason]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your reason]