search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Inconsistency in the spelling of NUSNet ID in DG and UG #1415

Open nus-pe-bot opened 5 months ago

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

image.png

image.png

image.png

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

wxiaoyun commented 5 months ago

Team's Response

We don't think this is valid. Because in the UG, it is consistent as NUSNet ID as the english name, and NUSNET as the parameter name in our syntax. Using NUSNet ID is consistent with official NUS documents.

In the DG, as it is inside a class diagram, we use the name of the class representing NUSNet ID in our codebase.

image.png

Referring to the Java coding standard: Abbreviations and acronyms should not be uppercase when used as a part of a name., so using NusNetId is correct in the diagram, as ID is a abbreviation for identification.

image.png

Duplicate status (if any):

--