search

glenngnng / pe

0 stars 0 forks source link

Hard to differentiate betweent the two diagrams for undo/redo in DG #15

Open glenngnng opened 10 months ago

glenngnng commented 10 months ago

image.png

There was no text to indicate what diagram this was or what its purpose was, hindering the user a little.

Furthermore they are extremely similar, making it hard to differentiate them.

nus-se-script commented 9 months ago

Team's Response

Thank you for your suggestion! In the making of this undo/redo documentation, we have done our best to position the "UndoCommand" and "RedoCommand" text in the middle of the diagram with quite a large font compared to the other texts to differentiate one another. In addition, we placed the diagram in the undo/redo section which should put readers in the same context as ours that we are talking about undo/redo implementation. About the issue that they are hard to differentiate, we need to point out that the purpose of undo/redo implementation section is not to compare the two commands, but rather to display and explain how they work and turns out they indeed are quite similar in terms of implementation. In the explaining paragraphs, readers can also notice that undo and redo is very similar in nature: undo is just "index - 1" and redo is just "index + 1". Because the purpose of the implementation section is to explain and display and not to compare between different commands, we had no intention to make them different noticeably for the readers, and therefore, we classify this bug as not a bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response!

I believe my point was not the comparison of how the two commands worked, but simply the fact that the two diagrams was not sufficiently labeled to give the user a clear idea of which diagram was which, which can be easily solved by adding some text to indicate which diagram is which.

Furthermore, while you mentioned that the purpose is to explain the two different commands and not differentiate, it will still be helpful to differentiate the commands to the reader.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]