Code snippet is hard to understand

[dinhnhobao]

It's better to explain it in plain English instead of code. I wouldn't know what hasLogWithSameDate and getLogByDate means

[nus-pe-bot]

Team's Response

Hi there.

Thanks for raising this.

The purpose of the code snippet was to show how the ReportCommand object decides to show an error message or not. Since this code snippet immediately follows an Activity Diagram directly above it, it is safe to assume a new developer would be able to understand the purpose behind it.

Furthermore, we also included a comment in the code snippet to exactly tell what the code does. The reason we wanted to show the relevant methods is because they are important for a new developer to know so that if they were to develop any new feature similar to report command, they would know which methods to call for exception handling.

Also, this is an example of top-down approach (which was taught in CS2101), where we explain high-level concepts (in Activity Diagram) and move to low-level details (like implementation via code snippets).

As such, we believe the code snippet is useful to the user and there is sufficient visual aids (Activity Diagram), explanations (comment) for the reader to appreciate the code snippet. Furthermore, the code is readable with descriptive method names and constant names.

Considering all of the above factors, we are rejecting this bug.

Cheers

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---