search

alvinlim277 / pe

0 stars 0 forks source link

UML diagrams are very dense #11

Open alvinlim277 opened 7 months ago

alvinlim277 commented 7 months ago

Some UML diagrams are very complicated and hinder readability, maybe it is possible to omit some details image.png

soc-se-bot commented 7 months ago

Team's Response

Since you did not give any elaboration, we are unsure which details you think are not necessary here. We feel that all the details in this diagram are necessary. We are trying show the internal operations of the logic package, in this case, for the edit command.

Each object plays an important role here in explaining the mechanism of the edit command.

The 'Original' Bug

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

Diagram too complicated

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.

image.png

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

Their Response to the 'Original' Bug

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

Since you did not give any elaboration, we are unsure which details you think are not necessary here. We feel that all the details in this diagram are necessary. We are trying show the internal operations of the logic package, in this case, for the edit command.

  • :Logic object is responsible for taking in user command, and control the overall logic of the programme. This is an important participant.
  • :NetworkBookParser object is responsible for assigning the parsing duty to the correct parser.
  • :EditCommandParser object is responsible for parsing the edit command itself.
  • :EditAction object represents the action of mutating an editable person. This is where we practice polymorphism so that each subclass represents a different kind of action.
  • :EditCommand object represents the command itself.
  • :EditPersonDescriptor object is the mutable version of the Person class.

Each object plays an important role here in explaining the mechanism of the edit command.

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.IssueUnclear`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]