nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Create profile attributes ref not explained #2939

Open nus-se-bot opened 2 years ago

nus-se-bot commented 2 years 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 would be good to include the documentation for this feature as it is a key part of the program


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

tlyi commented 2 years ago

Team's Response

We agree that we should have had a diagram for the "create Profile attributes" ref frame. However, we have marked this as severity Low as the current diagram was still able to explain the key points we were explaining for this segment, which is:

  1. On start up, the app checks if the profile is complete
  2. If it is complete, the current profile will be returned
  3. If it is not complete, the user will be prompted to create a new profile, and the new profile will only be returned after all attributes have been filled in.

Duplicate status (if any):

--