search

KiatLun / pe

0 stars 0 forks source link

Missing label for diagram #8

Open KiatLun opened 2 months ago

KiatLun commented 2 months ago

Theres 3 diagram, the first being "before edit" which shows the state before edit command is executed, the next is "edit" which show the edit command. The last diagram should have a label like the first 2 for example "After edit" to be clearer. image.png

nus-se-script commented 2 months ago

Team's Response

Same reason as for the labels for Delete, but in the context of Edit.

The 'Original' Bug

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

Missing label for diagram in UG

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.

There should be a label in the last diagram for example "After delete:" similar to the first 2 diagrams to complete the flow of the story it is trying to tell image.png

[original: nus-cs2103-AY2324S2/pe-interim#4803] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

Thanks for pointing this out.

After discussions within the team, we have decided to label this bug as response.NotInScope.

Reason:

The use of Delete instead of the use of both Delete and After Delete as labels is intentional as the use of both images is required to show the deletion process as a whole. The first image is technically a combination of both "during" and "after", the command being typed in the top box depicts the "during" and the result given by the application in the bottom box serves as the "after", thus it would not make sense to label the first image as simply During Delete and therefore splitting the two images into two separate labels would not be correct.

We thus opted for the simpler option of combining both images and labelling it as the Delete process.

Note: While response.NotInScope are not counted against the dev team, they can earn a small amount of consolation marks for the tester. The other three do not affect marks of either the dev team or the tester.

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

## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** I feel there should still be an extra label saying "after edit:" since it makes it clearer for the users to understand. You mentioned not making sense to label the first image "during edit" but instead maybe you can label it as "edit command" so making the labels more sensible. I feel it is good to label ur diagrams since it is common practise to do so and makes it clearer for the users.