Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SortActivityDiagram and Reorganise Implementations in DeveloperGuide #256

Merged
merged 12 commits into from
Apr 13, 2024

Conversation

whitesnowx
Copy link
Collaborator

@whitesnowx whitesnowx commented Apr 13, 2024

Actions:

  • Remove while() and appropriate notations to match CS2103 UML standards in SortActivityDiagram.puml
  • Reorder Implementations in DeveloperGude.md to match UserGuide.md
  • Change subheaders of implementations to standardise naming
  • Add Why sort is implemented this way

🖊️ 🐧

@whitesnowx whitesnowx self-assigned this Apr 13, 2024
@whitesnowx whitesnowx added this to the v1.4 milestone Apr 13, 2024
@whitesnowx whitesnowx added the type.Documentation Improvements or additions to documentation label Apr 13, 2024
@whitesnowx whitesnowx linked an issue Apr 13, 2024 that may be closed by this pull request
@whitesnowx whitesnowx closed this Apr 13, 2024
Copy link
Collaborator

@iynixil iynixil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! some comments


Need for `MultiComparator` object:
This is to map the 1 or more comparator objects and act as a layer of abstraction where `SortCommmand` does need to know how many attributes are used in sorting.
This also w
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clarification: incomplete sentence?

Copy link
Collaborator Author

@whitesnowx whitesnowx Apr 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amended

**Aspect: Determining order of sorting of an attribute:**

* **Current Design:** Get order of sorting from user, prompting for an input in the form of toCompare.
* **Current Design:** Get order of attributes sorting from user input.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Get order of attributes sorting -> Get sorting order of attributes may be clearer?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amended

@Pluiexo
Copy link

Pluiexo commented Apr 13, 2024

Noticed that you reordered that statements, as I was gonna do it too. But you can choose to merge this first, then I will make #249 follow your layout when dealing with the conflicts

@iynixil iynixil merged commit b01ee70 into AY2324S2-CS2103-F08-3:master Apr 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix While Notation in diagram
3 participants