Added docs

[NSFatalError]

Summary by CodeRabbit

• Documentation
  • Added a new overview document introducing the Publishable module and its features.
  • Enhanced documentation for the AnyPropertyPublisher class and its properties.
  • Provided detailed documentation for the Publishable macro and protocol, including usage notes and limitations.
  • Marked certain internal protocols and typealiases as private in generated documentation.
  • Added a configuration file to support documentation generation and publishing.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces comprehensive documentation enhancements and configuration for documentation publishing. New documentation files and detailed comments are added to key classes, protocols, and macros in the Publishable module. Additionally, documentation visibility is restricted for certain internal types, and a configuration file for documentation targets is introduced.

Changes

File(s)	Change Summary
.spi.yml	Added configuration file specifying documentation publishing targets.
Sources/Publishable/Documentation.docc/Publishable.md	Added a new documentation file introducing the Publishable module, its purpose, and main features.
Sources/Publishable/PropertyPublisher/AnyPropertyPublisher.swift	Added detailed documentation comments to AnyPropertyPublisher and its properties.
Sources/Publishable/PropertyPublisher/Publishable.swift	Added comprehensive documentation comments to the Publishable macro and protocol; updated protocol to conform to Observable.
Sources/Publishable/Registrars/PublishableObservationRegistrar.swift .../SwiftObservationRegistrar.swift	Marked protocol and typealias documentation visibility as private using the @_documentation(visibility: private) attribute.

Poem

In the warren, docs now bloom and grow,
With comments clear, so all may know.
A macro here, a protocol there,
Publishers change with utmost care.
Hidden details tucked away,
The Publishable path is bright today!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fcca7a3 and a33a89a.

📒 Files selected for processing (6)

• .spi.yml (1 hunks)
• Sources/Publishable/Documentation.docc/Publishable.md (1 hunks)
• Sources/Publishable/PropertyPublisher/AnyPropertyPublisher.swift (1 hunks)
• Sources/Publishable/PropertyPublisher/Publishable.swift (2 hunks)
• Sources/Publishable/Registrars/PublishableObservationRegistrar.swift (1 hunks)
• Sources/Publishable/Registrars/SwiftObservationRegistrar.swift (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!