search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

DeleteMember parameters are inconsistent #2023

Open nus-se-script opened 11 months ago

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

deleteMember parameters are inconsistent. 1st diagram shows the parameters as 1 while 2nd diagram shows it as m. This can give the reader the wrong impression that in the 2nd diagram the deleteMember method is taking in an Index instead of a member.

I deem it as medium severity as this is quite important for the reader to fully understand what is happening in the methods and the inconsistencies can cause alot of confusion. Issue also apparent in other places with deleteMember.

image.png

image.png

[original: nus-cs2103-AY2324S1/pe-interim#1541] [original labels: type.DocumentationBug severity.Medium]

jonasongg commented 11 months ago

Team's Response

We accept this bug report, but do not agree that the severity should be medium. We think this will cause only a minor inconvenience to developers since the overall structure and general flow of the diagram is still correct (deleteMember deletes a member from the model), and minor details such as method parameter type shouldn't affect the developers too much.

Duplicate status (if any):

--