tyuyang / pe

0 stars 0 forks source link

Return arrow looping the wrong way #13

Open tyuyang opened 1 year ago

tyuyang commented 1 year ago

Recipe possible command section, sequence diagram:

image.png

How in the world did you actually manage to make it loop the other way??? Technically a bug since I don't think you are allowed to loop the return arrow anti clockwise, plus it intersects with parts of the diagram which is not desirable. But wow I actually did not know PlantUML can do this.

nus-pe-script commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Developer Guide Recipe Possible Command return arrow one is from left the other is from right, not consistent

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

return of possiblerecipes is from the left, but canmakerecipe is from the right


[original: nus-cs2113-AY2223S2/pe-interim#1961] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

In this diagram, the direction of the return arrow is insignificant due to these factors:

  • there is only 2 return arrow from a self-invoked command which should not constitute to any form of "standardization/consistency" which should be reserved for larger groups.
  • the direction of the return arrow does not affect visibility since they do not obstruct or overlap other arrows/blocks.

    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: [replace this with your explanation]


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Their second point how the direction of the return arrow does not affect visibility is not really correct since it does affect the visibility of the variable possibleRecipes, which would not have been affected if the direction of the return arrow is looping through the right. By this rule: ![image.png](https://raw.githubusercontent.com/tyuyang/pe/master/files/9fc39e80-39af-4261-92f7-026699f0499c.png) since the bug does hinder the reader, albeit only slightly, it does fall under severity veryLow documentation error. Furthermore, since even minor typos and grammar errors are also considered bugs, for consistency, this should also be considered a minor bug. ![image.png](https://raw.githubusercontent.com/tyuyang/pe/master/files/a4bb8306-d006-4bac-adbe-0de1ec3cf2c1.png)