Jiale-Sun / pe

0 stars 0 forks source link

Too many decoder diagram in DG #8

Open Jiale-Sun opened 2 years ago

Jiale-Sun commented 2 years ago

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.

soc-pe-bot commented 2 years ago

Team's Response

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 response

Team chose [response.Rejected]

Reason for disagreement: I think there are too many diagrams for the decoder. I understand that the attributes and classes are different for each. However, they are handled very similarly; for some of them, shown in the previous screenshot I included in the "original" bug, they are exactly the same, with only naming differences.

Therefore, I think it's better to have a template of at least some decoders instead of all of them.

It is better to add some explanations to the diagrams in words as well.