search

Jnjy / pe

0 stars 0 forks source link

Unnecessary repetition of INDEX constraints #6

Open Jnjy opened 1 year ago

Jnjy commented 1 year ago

Below are examples of all repetitions of INDEX constraint:

View:

image.png

Copy:

image.png

Suggestion: Can add these example into the constraint section of UG to avoid repetitions.

nus-pe-script commented 1 year ago

Team's Response

Hi there! Thanks for raising this issue up.

Our team did mention the constraints for INDEX in the constraint section of the user guide (Page 11)

image.png

In the diagram that you have provided, our team's intention was not to repeat the constraints. Rather, the words after the command serve as an explanation on what you can expect after the command, and why are the output are as such. For example , for view -1, we explained why such a command would display an error.

If we did not include such explanations, a reader would have to keep navigating to and fro between the Constraints section and Appendix B. Thus, providing a simple one-liner explanation makes it much clearer and user-friendly for the reader to read and understand. Thus, our team feels that this is not an unnecessary repetition of INDEX constraints. As such, we would be rejecting this as a bug.

Hope the above clarifies!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thanks for your response!

I understand where you are coming from, by adding the constraint into each command will ease the readers' job when navigating the UG. While adding the constraint to each command may initially appear to ease the reader's navigation of the UG, it may actually cause more confusion as the reader could think that there are different constraints apply to different instances of INDEX. Thus, the reader will still have to navigate back and forth between those commands to reclarify on the constraints anyways.

Hence, it would be better if it is included in one single section so the reader know that the INDEX constraint clarified here applies for all INDEX instances in the UG. This would help to avoid any potential confusion that could arise from having the same constraint repeated multiple times in different sections of the UG.

If we did not include such explanations, a reader would have to keep navigating to and fro between the Constraints section and Appendix B

A suggestion to deal with the inconvenience of navigating back and fro will be having a hyper link to navigate to the Appendix.