Skip to content

docs(value-objects): add documentation for MedicationFrequency value object#34

Draft
gbrennon wants to merge 6 commits intomainfrom
docs/update-application-docs
Draft

docs(value-objects): add documentation for MedicationFrequency value object#34
gbrennon wants to merge 6 commits intomainfrom
docs/update-application-docs

Conversation

@gbrennon
Copy link
Copy Markdown
Owner

@gbrennon gbrennon commented Mar 9, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 9, 2026 06:33
@gbrennon gbrennon self-assigned this Mar 9, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new domain documentation page describing the MedicationFrequency value object and its invariants.

Changes:

  • Introduces docs/domain/value_objects/medication_frequency.md
  • Documents the purpose of the value object and lists its enum-like variants/invariants

@@ -0,0 +1,9 @@
# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs`
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

The title has a typo: MediationFrequency doesn’t match the actual value object name/path (MedicationFrequency). This can make the doc harder to find/search and inconsistent with the code.

Suggested change
# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs`
# `MedicationFrequency` -> `src/domain/value_objects/medication_frequency.rs`

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,9 @@
# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs`
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

Doc header format is inconsistent with other value object docs (they use an em dash separator, e.g. docs/domain/value_objects/dosage.md:1). Consider using the same # Typepath`` convention here for consistency.

Suggested change
# `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs`
# `MedicationFrequency` `src/domain/value_objects/medication_frequency.rs`

Copilot uses AI. Check for mistakes.

## Invariants

- This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

Grammar: “This follow” should be “This follows”.

Suggested change
- This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`.
- This follows an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`.

Copilot uses AI. Check for mistakes.
Comment on lines +3 to +9
A value object representing how often a medication should be taken.

---

## Invariants

- This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

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

This doc is much shorter than other value-object docs in this repo (which typically include sections like Constructor/Methods/Usage/Related). To keep documentation consistent and actionable, consider adding at least the constructor/methods (if any) and a Related section similar to the other files in docs/domain/value_objects/.

Copilot uses AI. Check for mistakes.
@gbrennon gbrennon marked this pull request as draft March 11, 2026 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants