StanfordSpezi / SpeziContact

Spezi module to display contact information
https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation/
MIT License
3 stars 1 forks source link

Adding coding examples for Contact and ContactOption - v2 with signed commits #25

Closed akanshyabhat closed 7 months ago

akanshyabhat commented 7 months ago

Adding coding examples for Contact and ContactOption - v2 with signed commits

:recycle: Current situation & Problem

When I was creating a contact for our application, I was unable to see coding examples. These added examples hope to clarify how someone might build and implement these features.

All of these changes were copied over from my previous pull request for signed commits.

:gear: Release Notes

N/A

:books: Documentation

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

akanshyabhat commented 7 months ago

@philippzagar: Here is my updated pull request for the other module! I am unable to request a review from you, but if you would be able to review it that would be great! I have copied over all of the changes that we discussed in the previous PR. You hadn't reviewed those, so that PR is still open so you can see how I changed the code according to your responses. Thank you so much!

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.69%. Comparing base (494b776) to head (a148ae5).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25/graphs/tree.svg?width=650&height=150&src=pr&token=XVZHKbnkdP&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #25 +/- ## ======================================= Coverage 78.69% 78.69% ======================================= Files 4 4 Lines 319 319 ======================================= Hits 251 251 Misses 68 68 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [Sources/SpeziContact/Models/Contact.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUNvbnRhY3QvTW9kZWxzL0NvbnRhY3Quc3dpZnQ=) | `100.00% <ø> (ø)` | | | [Sources/SpeziContact/Models/ContactOption.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUNvbnRhY3QvTW9kZWxzL0NvbnRhY3RPcHRpb24uc3dpZnQ=) | `86.96% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [494b776...a148ae5](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/25?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).
akanshyabhat commented 7 months ago

@philippzagar I wasn't too sure what you meant by combining the examples - if this is not what you wanted please feel free to let me know!

akanshyabhat commented 7 months ago

@philippzagar Thank you so much for the detailed example! I went ahead and made those changes :)