From bf0a83cffe86d8e1e4db873079d62fe5db9cfce3 Mon Sep 17 00:00:00 2001 From: Paul Date: Thu, 23 Jan 2025 18:52:25 +0100 Subject: [PATCH] Fix linkspector issues (#212) # Fix linkspector issues ## :recycle: Current situation & Problem Fixes #210 ## :gear: Release Notes *Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.* *Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.* ## :books: Documentation *Please ensure that you properly document any additions in conformance to [Spezi Documentation Guide](https://github.com/StanfordSpezi/.github/blob/main/DOCUMENTATIONGUIDE.md).* *You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.* ## :white_check_mark: Testing *Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.* *This section describes important information about the tests and why some elements might not be testable.* ### Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md). --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6e109dc6..a681ddad 100644 --- a/README.md +++ b/README.md @@ -484,12 +484,12 @@ Diuretics, if currently present as medication request, will be shown as a recomm |title|LocalizedText|e.g. "Carvedilol"|The name of the medication (not the tablet), e.g. coming from `medications/1998`.| |subtitle|LocalizedText|e.g. "Beta Blockers"|The medication class name, e.g. coming from `medicationClasses/0`.| |description|LocalizedText|e.g. "Personal target dose reached. No action required."|The explanation of the recommendation, displayed along with a summary of the medication.| -|type|[Medication Recommendation Type](#Medication-Recommendation-Type)|e.g. "personalTargetDoseReached"|See [Medication Recommendation Type](#Medication-Recommendation-Type) for more information.| +|type|[Medication Recommendation Type](#medication-recommendation-type)|e.g. "personalTargetDoseReached"|See [Medication Recommendation Type](#medication-recommendation-type) for more information.| |videoPath|optional string|e.g. `videoSections/1/videos/3`|This is the video to show when the recommendation is tapped. The clients may want to hide the icon to get to the video when this value is not present.| -|dosageInformation|DosageInformation|See [Dosage Information](#Dosage-Information)|A description of the current, minimum, and target doses for a given medication. +|dosageInformation|DosageInformation|See description below|A description of the current, minimum, and target doses for a given medication. When the patient is not yet taking the medication, its currentSchedule will be an empty list.| -The `DosageInformation` property contains the following information: +The `dosageInformation` property contains the following information: |Property|Type|Values|Comments| |-|-|-|-|