search

kum-wh / pe

0 stars 0 forks source link

Similar diagrams #7

Open kum-wh opened 2 years ago

kum-wh commented 2 years ago

The decoding attributes reference diagram contains many similar sequence diagram. Maybe can use XYZ like the sequence diagram in the ParserManger.

soc-pe-bot commented 2 years ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Too many decoder diagram in DG

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

Too many diagrams for the decoder. They are almost the same with only name differences. I think it's better to have a template of the decoders instead of all of them.

What is more is that it is better to add some explanations to the diagrams, such as creating objects and calling methods.

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

Their Response to the 'Original' Bug

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

We thought that it was important to explain the decoding for all attributes, as all the attributes have their own class, and some are handled differently in the code. Hence, a template would not have sufficed to explain all of them.

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 reason]

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]

:question: Issue severity

Team chose [severity.Medium] Originally [severity.VeryLow]

Reason for disagreement: [replace this with your reason]