search

Charles1026 / pe

0 stars 0 forks source link

Missing Sequence Diagrams for View, Sort and Copy commands #20

Open Charles1026 opened 1 year ago

Charles1026 commented 1 year ago

The inclusion of diagrams in these segments, similar to the import feature would have explained the concepts a lot better.

soc-pe-bot commented 1 year ago

Team's Response

Duplicate of #2989, this issue also points out the lack of diagrams for these features/commands.

The 'Original' Bug

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

UML diagrams have not been displayed for the various commands

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.

Having UML diagrams would aid the understanding of the various commands that have been implemented in the program such as ViewCommand, SortCommand, CopyCommand

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

Their Response to the 'Original' Bug

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

We agree that having UML diagrams would help other developers to understand our implementation better and improve the quality of the DG.

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 severity

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

Reason for disagreement: Very low is only reserved for typos and issues that do not affect readability. Failure to include a diagram to illustrate the concept greatly limits readability for the user and should be marked as low.