nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Lack of standardisation of diagrams in UG #2067

Open nus-pe-bot opened 1 year ago

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


Lack of standardisation of diagrams in UG

Some diagrams in the UG are labelled, some are not.

Examples

Example labelled

Screenshot 2022-11-11 at 5.28.41 PM.png

Example not labelled

Screenshot 2022-11-11 at 5.28.09 PM.png


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

kelvinou01 commented 1 year ago

Team's Response

The diagram in the second image is already described on the top. Standardization is not a requirement.

"A foolish consistency is the hobgoblin of little minds." -- PEP8

Duplicate status (if any):

--