StanfordSpezi / SpeziContact

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

Update Documentation in Conformance to the Documentation Guide #17

Closed vishnuravi closed 1 year ago

vishnuravi commented 1 year ago

Update Documentation in Conformance to the Documentation Guide

:recycle: Current situation & Problem

Addresses #11.

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

codecov[bot] commented 1 year ago

Codecov Report

Merging #17 (95a2e29) into main (2d2b809) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17/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/17?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #17 +/- ## ======================================= Coverage 80.07% 80.07% ======================================= Files 5 5 Lines 311 311 ======================================= Hits 249 249 Misses 62 62 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [...urces/SpeziContact/Contact Views/ContactView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUNvbnRhY3QvQ29udGFjdCBWaWV3cy9Db250YWN0Vmlldy5zd2lmdA==) | `81.35% <ø> (ø)` | | | [...rces/SpeziContact/Contact Views/ContactsList.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUNvbnRhY3QvQ29udGFjdCBWaWV3cy9Db250YWN0c0xpc3Quc3dpZnQ=) | `51.86% <ø> (ø)` | | | [Sources/SpeziContact/Models/Contact.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?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/17?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aUNvbnRhY3QvTW9kZWxzL0NvbnRhY3RPcHRpb24uc3dpZnQ=) | `86.16% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?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/17?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [2d2b809...95a2e29](https://app.codecov.io/gh/StanfordSpezi/SpeziContact/pull/17?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).