search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Irrelevant NFR #4747

Open nus-pe-bot opened 4 months ago

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

DG page 65 NFR item 7:

All code snippets presented in the developer guide shall follow a consistent coding style and formatting, adhering to the module’s coding standards and best practices.

There are no code snippets in this DG. This NFR is irrelevant.

[original: nus-cs2103-AY2324S2/pe-interim#4162] [original labels: severity.Low type.DocumentationBug]

jannaleong commented 4 months ago

Team's Response

Our DG does indeed contain code snippets. Some examples are in our manual testing section, specifically the command examples. These are code snippets. These example commands all follow a consistent coding style and formatting as specified in our NFR.

We have screenshotted some examples below:

image.png

Following the definition below, such command examples are code snippets as it is a reusable block of code users can use to test the product.

image.png

However, if you do not agree with this definition, we offer further reasoning. By tp bug guidelines it says that if "non-functional requirements are not met by the product", then "it can be a severity.Low DocumentationBug". So, this would be a valid bug if the NFR is unfulfilled. However, this NFR is fulfilled. If you argue that we do not have code snippets to begin with, this guideline is immediately fulfilled as this statement is vacuously true.

Duplicate status (if any):

--