search

shayaansultan / pe

0 stars 0 forks source link

No mention of HousingType limitation in UG before Adding a buyer section #14

Open shayaansultan opened 2 months ago

shayaansultan commented 2 months ago

In the Adding a buyer section, or anytime before it, there is no mention that the HousingType should be limited to HDB, Condo or landed, thus the user does not know up till now that there is such a restriction. This restriction should be mentioned in the notes and a user should not have to input an incorrect/invalid command to find out about this restriction

image.png

nus-se-script commented 2 months ago

Team's Response

Good catch! We can include the HousingType in the Variable Constraints in UG as mentioned in #4382 issue.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Incomplete Variable Constraints in UG

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.

In the variable constraints section of the UG, there should also be mention of any limitation on housingType (that there are only 3 possible values for it), but it does not.

image.png

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Good catch! But we believe that the housingType is mentioned in other commands. Therefore, it is sufficient enough to imply that there are only 3 types. image.png

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: Even if it is mentioned in other commands, these commands only come below in the UG, thus the user is left unaware at this point, thus a documentation bug.