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

Wrong use of object name in object diagram #22

Open
adammangzijun opened this issue Nov 17, 2023 · 1 comment
Open

Wrong use of object name in object diagram #22

adammangzijun opened this issue Nov 17, 2023 · 1 comment

Comments

@adammangzijun
Copy link
Owner

adammangzijun commented Nov 17, 2023

image.png

I do not think there should be _ used at all, also the object name should not be the description of the note itself, it is a field of the Note object instead.

@soc-pe-bot
Copy link

soc-pe-bot commented Nov 21, 2023

Team's Response

Thank you for pointing it out! The bug is purely cosmetic and does not affect the understanding of how the "noteCompany" command work and is unlikely to confuse the reader, hence we have decided to change it to Severity.VeryLow.

Items for the Tester to Verify

❓ Issue severity

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

  • I disagree

Reason for disagreement: For this case, I am trying to point out that the object name shouldn't be the description of the note itself. This purely is a incorrect storing of the note description, rather should be shown as an attribute instead. This violates the coding style as well if I am not wrong.

For example:
usually it will be
Note newNote = new Note("Looking for aspiring frontend developers");

rather than:

Note Looking for aspiring frontend developers= new Note();

This shows the misunderstanding of the use off object diagram. That is why I flagged it out as severity.Low


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants