StanfordSpezi / SpeziViews

A common set of SwiftUI views and related functionality used in Spezi modules
https://swiftpackageindex.com/StanfordSpezi/SpeziViews/documentation/
MIT License
4 stars 3 forks source link

Improve documentation conciseness #26

Closed Supereg closed 9 months ago

Supereg commented 9 months ago

Minor documentation improvements

:recycle: Current situation & Problem

This PR revises the summary header for some of the types to deliver a more precise documentation catalog.

:gear: Release Notes

:pencil: Code of Conduct & Contributing Guidelines

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

codecov[bot] commented 9 months ago

Codecov Report

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

Comparison is base (dccc827) 78.20% compared to head (cd1e74d) 78.20%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26/graphs/tree.svg?width=650&height=150&src=pr&token=7UbLX71dAO&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #26 +/- ## ======================================= Coverage 78.20% 78.20% ======================================= Files 36 36 Lines 1096 1096 ======================================= Hits 857 857 Misses 239 239 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [.../SpeziValidation/Views/ValidationResultsView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aVZhbGlkYXRpb24vVmlld3MvVmFsaWRhdGlvblJlc3VsdHNWaWV3LnN3aWZ0) | `100.00% <ø> (ø)` | | | [Sources/SpeziViews/Model/ViewState.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aVZpZXdzL01vZGVsL1ZpZXdTdGF0ZS5zd2lmdA==) | `97.83% <ø> (ø)` | | | [...Views/ViewModifier/ViewState/ViewStateMapper.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aVZpZXdzL1ZpZXdNb2RpZmllci9WaWV3U3RhdGUvVmlld1N0YXRlTWFwcGVyLnN3aWZ0) | `100.00% <ø> (ø)` | | | [...es/SpeziViews/Views/HorizontalGeometryReader.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aVZpZXdzL1ZpZXdzL0hvcml6b250YWxHZW9tZXRyeVJlYWRlci5zd2lmdA==) | `100.00% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?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/SpeziViews/pull/26?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [dccc827...cd1e74d](https://app.codecov.io/gh/StanfordSpezi/SpeziViews/pull/26?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).
PSchmiedmayer commented 9 months ago

Thank you @Supereg! 🚀