search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

unclear sequence diagram in Student Details #127

Open nus-se-script opened 3 months ago

nus-se-script commented 3 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

it is not immediately clear to the reader what exactly the N variable here is referring to.

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

tayponghee commented 3 months ago

Team's Response

The convention for N is correct as per the Java Guidelines, for the size of an array. Moreover, it is shown in the same screenshot as to what N is referring to. Using a longer name for N would have made the diagram more unreadable.

Duplicate status (if any):

--