search

nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Unclear phrasing in DG #1300

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

Are 'the following section' and 'this section' referring to the same section? If so, it will be clearer to use 'this section' for both.

Snipaste_2020-11-13_17-34-45.png

[original: nus-cs2113-AY2021S1/pe-interim#1185]

EyoWeiChin commented 3 years ago

Team's Response

Hi thank you for the feedback. Our team has decided to downgrade this bug as we felt that while they referred to different sections as described below, we should have swapped its ordering so that it would not be as confusing.

In this case, they are referring to separate sections. "The following section" refers to 3.1 Architectural Design "This section starts." refers to 3. Design.

Duplicate status (if any):

--