docs(value-objects): add documentation for MedicationFrequency value object#34
docs(value-objects): add documentation for MedicationFrequency value object#34
Conversation
There was a problem hiding this comment.
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` | |||
There was a problem hiding this comment.
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.
| # `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs` | |
| # `MedicationFrequency` -> `src/domain/value_objects/medication_frequency.rs` |
| @@ -0,0 +1,9 @@ | |||
| # `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs` | |||
There was a problem hiding this comment.
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 # Type—path`` convention here for consistency.
| # `MediationFrequency` -> `src/domain/value_objects/medication_frequency.rs` | |
| # `MedicationFrequency` — `src/domain/value_objects/medication_frequency.rs` |
|
|
||
| ## Invariants | ||
|
|
||
| - This follow an enum pattern with variants like `OnceDaily`, `TwiceDaily`, `EveryXHours(u8) or Custom(String)`. |
There was a problem hiding this comment.
Grammar: “This follow” should be “This follows”.
| - 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)`. |
| 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)`. |
There was a problem hiding this comment.
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/.
No description provided.