README.md (4)

7-7: Use a lower heading level for the Contents section
Heading levels should only increment by one at a time (H1 → H2). Change from #### Contents to ## Contents to satisfy markdownlint.

-#### Contents
+## Contents

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4

(MD001, heading-increment)

---

23-56: Consider demonstrating Cancellable management
Subscriptions returned by sink are cancelled immediately if not stored. You might show how to retain them, for example in a Set<AnyCancellable>.

var cancellables = Set<AnyCancellable>()

let nameCancellable = person.publisher.name
    .sink { name in
        print("Name –", name)
    }
    .store(in: &cancellables)

---

60-60: Add missing article for clarity
Insert “the” before “Observation module” to read “the Observation module”.

-The `@Publishable` macro relies on two key properties of Swift Macros and `Observation` module:
+The `@Publishable` macro relies on two key properties of Swift Macros and the `Observation` module:

🧰 Tools

🪛 LanguageTool

[uncategorized] ~60-~60: You might be missing the article “the” here.
Context: ... two key properties of Swift Macros and Observation module: - Macro expansions ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

73-80: Provide full Package.swift context
The installation snippet shows only .package(...); wrapping it in a dependencies: [...] block will make it clearer how to integrate Publishable.

-```swift
-.package(
-    url: "https://github.com/NSFatalError/Publishable",
-    from: "1.0.0"
-)
-```
+```swift
+dependencies: [
+    .package(
+        url: "https://github.com/NSFatalError/Publishable",
+        from: "1.0.0"
+    )
+]
+```

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

README.md (6)

7-10: Heading level inconsistency in Contents.

The "#### Contents" heading skips levels (h1 → h4). For better markdown structure, use ## Contents (h2) or ### Contents to increment by one level.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

7-7: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4

(MD001, heading-increment)

---

12-17: Improve grammar and line wrapping.

The first paragraph is informative, but splitting the sentence "as it
publishes..." across lines 15–16 interrupts flow. Also, remove the trailing comma at the end of line 14 or merge lines 15–16 for readability.

---

23-36: Clean up code example formatting.

• Remove the trailing space on import Publishable (line 24).
• Ensure consistent indentation (4 spaces in Swift examples).
• In the inline comment at line 44, refer to the @Published property wrapper (include the @).

---

37-47: Clarify code comment notation.

The inline comments demonstrating output are helpful, but ensure each comment line begins with // and insert blank lines around examples to improve readability in rendered markdown.

---

58-62: Missing article before “Observation module”.

Update line 60 to read:

The @Publishable macro relies on two key properties of Swift Macros and the Observation module:
for grammatical correctness.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~60-~60: You might be missing the article “the” here.
Context: ... two key properties of Swift Macros and Observation module: - Macro expansions ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

73-80: Installation snippet could be expanded.

Consider showing how to add Publishable to your target’s dependencies in Package.swift. E.g.:

.package(
    url: "https://github.com/NSFatalError/Publishable",
    from: "1.0.0"
),
.target(
    name: "YourApp",
    dependencies: ["Publishable"]
)

This will help users integrate the package end‐to‐end.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

README.md (3)

8-11: Fix heading level for table of contents
The “Contents” heading is currently level 4 (####). It should increment by one level at a time (e.g. level 2) after the H1 title to maintain proper hierarchy.

-#### Contents
+## Contents

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

8-8: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4

(MD001, heading-increment)

---

61-61: Add missing article for clarity
Consider inserting “the” before “Observation module” to read “properties of Swift Macros and the Observation module:”. This small tweak improves readability.

-… two key properties of Swift Macros and `Observation` module:
+… two key properties of Swift Macros and the `Observation` module:

🧰 Tools

🪛 LanguageTool

[uncategorized] ~61-~61: You might be missing the article “the” here.
Context: ... two key properties of Swift Macros and Observation module: - Macro expansions ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

75-82: Include a License section
To clarify the project’s licensing terms, it’s best practice to add a “## License” section at the end of the README. For example:

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Would you like me to draft a full license section or set up the corresponding LICENSE file?

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting