search

mihirheda02 / pe

0 stars 0 forks source link

UG compulsory and optional arguments #11

Open mihirheda02 opened 5 months ago

mihirheda02 commented 5 months ago

In the UG it mentions that commands will use the format of compulsory arguments being in [] and optional arguments in {}, but that format isn't used for any of the commands other than list, making it confusing which arguments I'm supposed to specify and which ones aren't necessary.

In this document, parameters inside [] are compulsory, while those inside {} are optional.

soc-pe-bot commented 5 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]

Inconsistent command format across UG and DG

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.

In the UG, I realised that [ ] were not used, even though they were specified at the start.

image.png

image.png

In the DG, I realised that [ ] were used instead.

image.png

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

Their Response to the 'Original' Bug

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

Sure, we could be more consistent there, thanks.

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I don't think the severity of this is `VeryLow` because it isn't just a cosmetic issue or a typo. Any user who is going through the User Guide and trying to use the app won't know whether the params that they are supposed to input are optional or compulsory.