Open benmurphyy opened 2 years ago
Hi! Thank you for bringing up this issue. This is similar to issue #2233.
[The team marked this bug as a duplicate of the following bug]
Forgot to remove unnecessary details in DG
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.
![]()
[original: nus-cs2103-AY2122S2/pe-interim#2218] [original labels: severity.Low type.DocumentationBug]
[This is the team's response to the above 'original' bug]
Hi! Thank you for bringing up this issue. This is due to us not updating this text section in the final release.
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]
Team chose [severity.VeryLow
]
Originally [severity.Medium
]
Reason for disagreement: The severity of this bug is not Very Low, as Very Low bugs can only be cosmetic (typos, font problems, spacing etc).
I also refer to an email i sent to Prof Damith regarding this, agreeing that such an issue is definitely not cosmetic:
This bug is much more than just cosmetic, as this part of the developer guide about the Model components mentions non-existent classes that contradict directly with the already hard to see Model diagrams. At best, it leads to inconvenience for most readers (Medium) as they may get confused regarding these classes and hence have to find out for themselves (perhaps looking through source code) whether these classes indeed exist, or at worst, it may lead to them thinking that the class AddressBook
actually exists due to small model diagrams causing them not to notice that such a class AddressBook
does not exist.
Here is a screenshot of the portion of the DG containing this portion. As you can see, it takes up a fairly large portion of the section about model components, and is much easier to notice than the small model diagrams containing the actual classes that exist.
Old reference to AB3 remains here. Confusing to suddenly read about AddressBook instead of HustleBook, will take most readers some time to figure out that such a class
AddressBook
does not exist, and that they are referring to HustleBook, especially if they are not familiar with AB3 project.