search

nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Sequence diagram in the Design section #760

Open nus-se-script opened 4 months ago

nus-se-script 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.

image.png

The attribute being returned above does not have a type like a String

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

YHWong20 commented 4 months ago

Team's Response

Firstly, reassigning the bug severity from Medium to Low as this is not that severe of a bug.

Next, it was previously shown in the diagram that outputString is indeed of type String (for number 9).

image.png

The type of this attribute can therefore be implied. Furthermore, the omission of this detail did not necessarily hinder your ability to understand what's happening (as you could correctly infer that outputString is of type String). As per the course website:

image.png

Duplicate status (if any):

--