Skip to content

add erdFormat to the example config#9

Open
lsmith77 wants to merge 1 commit intosheldonj:mainfrom
lsmith77:patch-1
Open

add erdFormat to the example config#9
lsmith77 wants to merge 1 commit intosheldonj:mainfrom
lsmith77:patch-1

Conversation

@lsmith77
Copy link

@lsmith77 lsmith77 commented Mar 10, 2026

Summary by CodeRabbit

  • Documentation
    • Updated plugin configuration documentation with the new erdFormat = 'both' option example.

@coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 825227ef-551d-4694-a9df-181f713c5f31

📥 Commits

Reviewing files that changed from the base of the PR and between 5cb84b0 and 98f2895.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Documentation update adding the erdFormat = 'both' configuration option to the plugin example block in README.md. This demonstrates the new configuration option availability without modifying any application logic.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added erdFormat = 'both' configuration option to plugin documentation example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A config line hops into README's light,
erdFormat = 'both' shines oh so bright,
Documentation dances, examples feel new,
One little addition, refreshed through and through! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding erdFormat to the example configuration in the README. It is clear, specific, and directly reflects the only modification in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant