search

nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect notation in Parser and Logic component in the developer guide #1507

Open nus-pe-bot opened 2 days ago

nus-pe-bot commented 2 days ago

Description:

The association label used in the logic and parser components are not correct. It uses <<create>> in the parser class which is the incorrect notation. The valid notation that was taught in CS2103T is the association label create followed by the direction.

The logic and parser components are in critical components of the app, if a developer working on this app misinterpret these critical notation, they will introduce bugs that are detrimental to the app.

Steps to reproduce:

  1. Open the developer guide
  2. Scroll to the logic or Parser component

Screenshots:

image.png

image.png

[original: nus-cs2103-AY2425S1/pe-interim#2081] [original labels: severity.Low type.DocumentationBug]

jktang14 commented 1 day ago

Team's Response

Hi

We agree that this is a small enhancement that can be made in the future, for now, we feel it is clear enough which class is creating/calling a particular class.

Duplicate status (if any):

--