UG Repetitive example

[icytornado]

The third example is not necessary, just having the first and second one is enough. The first example shows all the compulsory fields, the second example shows the inclusion of an optional field.

Otherwise, if you have n optional fields, you will be putting in n examples for every optional field, which is not necessary.

Also it's long for the reader to read, not concise enough. It is not convenient to read everything.

[nus-pe-bot]

Team's Response

Duplicate issue of #2541, the explanation is given at the other issue.

The 'Original' Bug

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

Unnecessary repetitions of example commands

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.

---

One or two would have sufficed, this many examples with a large chunk of text might be confusing to readers.

---

_{[original: nus-cs2103-AY2021S2/pe-interim#2541] [original labels: severity.Medium type.DocumentationBug]}

Their Response to the 'Original' Bug

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

First of all, severity is downgraded from medium to low because the examples are unlikely to affect the normal reading of the UG and it only causes minor inconvenience.

The team is rejecting this issue because our intention was to show concrete examples of the possible variations of the command.

The first example demonstrates an add command with all the compulsory fields. The second example demonstrates an add command with multiple tags. The third example demonstrates an add command with optional fields.

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.Rejected]

• [x] I disagree

Reason for disagreement: I disagree,

According to the dev team:

" The first example demonstrates an add command with all the compulsory fields. The second example demonstrates an add command with multiple tags. The third example demonstrates an add command with optional fields. "

However, i dont know they need the second example to demonstrate multiple tags. Having the first and third example is enough, because tag is also an optional field. The second and third example can be considered as duplicate. Two examples would have sufficed. First example to demonstrate the add command with all the compulsory fields, second example to demonstrate the add command with optional fields.

---