nus-cs2113-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Contents could include a future version section to signal to future developers #1303

Open nus-pe-bot opened 2 years ago

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


Screenshot 2022-04-16 at 5.25.18 PM.png


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

warrencxw commented 2 years ago

Team's Response

The screenshot taken refers to the user guide, and assuming that is the context given by the bug poster, there is no need for any signaling to the developer in the user guide as it is targeted to the users. Anything that we have to signal to future developers should be in the developer guide instead.

Furthermore this bug post is crafted as a suggestion and thus the team has decided to reject this.

Duplicate status (if any):

--