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 Developer Guide #282

Merged
merged 11 commits into from
Nov 7, 2021
Merged

Update Developer Guide #282

merged 11 commits into from
Nov 7, 2021

Conversation

didymental
Copy link

@didymental didymental commented Nov 7, 2021

This PR resolves #267

Edit: PR is completed.

@didymental didymental added this to the v1.4 milestone Nov 7, 2021
@codecov-commenter
Copy link

codecov-commenter commented Nov 7, 2021

Codecov Report

Merging #282 (9f738c3) into master (750d80b) will increase coverage by 2.91%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #282      +/-   ##
============================================
+ Coverage     62.85%   65.76%   +2.91%     
- Complexity      650      691      +41     
============================================
  Files           116      116              
  Lines          2412     2445      +33     
  Branches        278      283       +5     
============================================
+ Hits           1516     1608      +92     
+ Misses          790      729      -61     
- Partials        106      108       +2     
Impacted Files Coverage Δ
src/main/java/seedu/docit/model/EntryList.java 100.00% <ø> (+22.22%) ⬆️
...java/seedu/docit/model/patient/MedicalHistory.java 74.50% <ø> (ø)
...ava/seedu/docit/model/appointment/Appointment.java 76.40% <0.00%> (-0.65%) ⬇️
...main/java/seedu/docit/logic/parser/ParserUtil.java 74.64% <0.00%> (+2.81%) ⬆️
...c/main/java/seedu/docit/model/AppointmentBook.java 56.60% <0.00%> (+3.77%) ⬆️
...ocit/logic/parser/AddAppointmentCommandParser.java 88.23% <0.00%> (+23.52%) ⬆️
...pointment/AppointmentContainsPatientPredicate.java 92.30% <0.00%> (+25.64%) ⬆️
...eedu/docit/storage/JsonAppointmentBookStorage.java 100.00% <0.00%> (+54.54%) ⬆️
...docit/storage/JsonSerializableAppointmentBook.java 100.00% <0.00%> (+68.75%) ⬆️
...va/seedu/docit/storage/JsonAdaptedAppointment.java 70.73% <0.00%> (+70.73%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 750d80b...9f738c3. Read the comment docs.

Comment on lines 31 to 38
Class MedicalEntry
Class EntryList
class "{abstract}\nEntry" as Entry
class Entry.Some<MedicalEntry> MODEL_COLOR {
}

class Entry.Empty<Object> MODEL_COLOR {
}

Choose a reason for hiding this comment

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

image
This might be too detailed for an overview

Copy link
Author

Choose a reason for hiding this comment

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

Reduced detail by putting a note


The following activity diagram summarises what happens within `AddMedicalEntryCommandParser` when the user executes an Add Medical Entry command.

![Activity diagram of Add Medical Entry Feature](diagrams/AddMedicalEntryFeatureActivityDiagram.png)

Choose a reason for hiding this comment

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

This diagram is repeated. Can similar structural diagrams be combined together?

Copy link
Author

Choose a reason for hiding this comment

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

Think we should have an activity diagram for each command since each command will have different scenarios / key things to take note of, even though the overall structure may be similar.

Copy link

@joshenx joshenx left a comment

Choose a reason for hiding this comment

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

lgtm

@didymental didymental merged commit 740900d into master Nov 7, 2021
@didymental didymental added the documentation Improvements or additions to documentation label Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Developer Guide for Medical History
4 participants