nus-cs2113-AY2223S2 / pe-dev-response

0 stars 0 forks source link

Invalid sequence diagram notation for "parse response" in LiveCurrencyApi #2165

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year 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.


Screen Shot 2023-04-14 at 17.28.41.png

Unsure what the "parse response" and dotted arrow is supposed to be as it does not follow sequence diagram notation. Dotted arrows are used to indicate the return from a method.


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

Rayleigh47 commented 1 year ago

Team's Response

For the response it is a return from the http get request made to the exchange api. For the parse response, it is not an actual function however the string has gone through some manipulation to be ready to be used in the program, therefore indicated by a return arrow instead of a solid arrow.

We chose to use minimal notation for the diagrams.

minimal.jpg

Duplicate status (if any):

--