nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Sequence for editing expiration date, incorrect format #2309

Open nus-se-script opened 5 months ago

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


For editing Expiration date sequence diagram, Object names should have colon before it to indicate the class type. Example: "GroceryList" should be ":GroceryList"

image.png

Class example where objects have "name:Class" format, and if there is no name then use ":Class"

image.png


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

64-1 commented 5 months ago

Team's Response

i am trying to represent a system component rather than a specific instance of a class, I think the colon may be omitted. But anyways, i will accept this as this is definitely not the best representation.

Duplicate status (if any):

--