Skip to content

edit lexicon style guide so that all union variants must be object or… - #128

Merged
s-adamantine merged 1 commit into
developfrom
edit-lexicon-style-guide
Jan 23, 2026
Merged

edit lexicon style guide so that all union variants must be object or…#128
s-adamantine merged 1 commit into
developfrom
edit-lexicon-style-guide

Conversation

@s-adamantine

@s-adamantine s-adamantine commented Jan 23, 2026

Copy link
Copy Markdown
Contributor

… record types

Inspired by @Kzoeps 's PR
#126

Summary by CodeRabbit

  • Documentation
    • Updated Unions guideline in the style guide with specific constraints requiring all union variants to be object or record types, excluding strings and numbers.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot

changeset-bot Bot commented Jan 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: df4c001

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jan 23, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Updated the Unions guideline in the style documentation to clarify that union type variants must be object or record types only, excluding primitive types like strings or numbers, per ATProto specification requirements.

Changes

Cohort / File(s) Summary
Documentation Update
LEXICON_STYLE_GUIDE.md
Tightened Unions guideline to explicitly restrict variants to object/record types only; primitive types prohibited per ATProto spec

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A union needs structure, not strings loose and wild,
Objects and records—the spec's favorite child.
No numbers or text floating free in the mix,
Just proper-typed variants to handle the tricks! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically identifies the main change: updating the lexicon style guide to require union variants to be object or record types, which aligns directly with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Lexicon Documentation Sync ✅ Passed Initial repository creation with synchronized lexicon files, README.md, ERD.puml, and SCHEMAS.md. Auto-generated SCHEMAS.md matches all documented lexicons and ERD entities.
Lexicons Styleguide Compliance ✅ Passed PR updates LEXICON_STYLE_GUIDE.md to document that union variants must be object or record types. All existing lexicon files comply with this requirement using references to object/record types.

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


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.

@s-adamantine
s-adamantine merged commit eec3d5e into develop Jan 23, 2026
4 checks passed
@s-adamantine
s-adamantine deleted the edit-lexicon-style-guide branch January 23, 2026 07: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.

1 participant