search

tzixi / pe

0 stars 0 forks source link

Contrasting parameter naming convention #13

Open tzixi opened 1 year ago

tzixi commented 1 year ago

UG states at the start that UPPER_CASE words are user- inputs, and this convention was largely followed except for certain functions such as in the second image, where index and description are in lower case

image.png

image.png

nus-se-bot 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]

Inconsistent formatting of command format in UserGuide

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.

Earlier in the Features section, it is specified that parameters supplied by the user are in UPPER_CASE:

image.png

However, in the addtorecipe command section, the format uses lower case for the names of the arguments:

Screenshot 2023-04-14 172303.png

The formatting of the format section for the commands in the user guide is thus inconsistent. However this is a cosmetic bug so the severity is VeryLow.

[original: nus-cs2113-AY2223S2/pe-interim#1023] [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)

Reason for disagreement: [replace this with your explanation]