search

nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

Overly Repetitive Explanation in UG #2534

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.

Screen Shot 2023-04-14 at 5.32.52 PM.png Fig 1

The first two lines and the use case are essentially the same. If there is not a lot ot elaborate, reader suggesting conciseness over repetition.

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

Rayleigh47 commented 1 year ago

Team's Response

In the use case portion, we are further elaborating on the command. Additionally, consistency of our UG format takes precedence over repetitiveness, given that it is only one line. Therefore, we chose to use such a format.

Duplicate status (if any):

--