Skip to content

Conversation

@esmerel
Copy link
Contributor

@esmerel esmerel commented Dec 18, 2025

This updates a few vale tests for spelling, headings, and acronyms to reduce suggestions for things that are valid.

Summary by CodeRabbit

  • Chores
    • Updated Vale linting configuration to recognize additional acronyms (RFC, IAM, MSK, OTLP) and spelling exceptions (ARNs), reducing false style warnings in documentation and content reviews.

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

Signed-off-by: Lynette Miles <[email protected]>
@esmerel esmerel requested review from a team as code owners December 18, 2025 19:49
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 18, 2025

Walkthrough

This PR expands Vale style rule exceptions by adding acronym and spelling entries across three configuration files: RFC and IAM/MSK/OTLP/RFC to acronym and heading rules, and ARNs to spelling exceptions.

Changes

Cohort / File(s) Summary
Vale acronym and heading exceptions
vale-styles/FluentBit/Acronyms.yml, vale-styles/FluentBit/Headings.yml
Added RFC to acronyms exceptions and IAM, MSK, OTLP, RFC to headings exceptions, exempting these terms from capitalization and expansion rules
Spelling exceptions
vale-styles/FluentBit/Spelling-exceptions.txt
Added ARNs as a new spelling exception entry

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

4.2.1

Poem

🐰 Hop-hip-hooray, exceptions grow!
RFC, IAM, and ARNs take their bow,
Vale's rules now bend for the acronyms we know,
Style guides expand—let the linting flow!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'Vale: updating tests' is vague and misleading—it describes generic test updates rather than the actual changes, which are adding spelling, heading, and acronym exceptions to Vale style rules. Revise the title to clearly describe the main change, such as 'Vale: add spelling and acronym exceptions for Fluent Bit documentation' or 'Vale: update dictionary and style exceptions for improved accuracy'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch lynettemiles/sc-158087/fluent-dictionary-updates

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e21b77 and 7fe3c27.

📒 Files selected for processing (3)
  • vale-styles/FluentBit/Acronyms.yml (1 hunks)
  • vale-styles/FluentBit/Headings.yml (4 hunks)
  • vale-styles/FluentBit/Spelling-exceptions.txt (1 hunks)
🔇 Additional comments (3)
vale-styles/FluentBit/Headings.yml (1)

90-90: LGTM! Heading exceptions correctly added.

All four additions (IAM, MSK, OTLP, RFC) are correctly alphabetized within the exceptions list and represent valid terms that should be exempt from sentence-style capitalization in headings.

Also applies to: 113-113, 127-127, 138-138

vale-styles/FluentBit/Spelling-exceptions.txt (1)

9-9: LGTM! Spelling exception correctly added.

The addition of "ARNs" is correctly alphabetized and appropriately complements the existing "ARN" entry in the acronyms list.

vale-styles/FluentBit/Acronyms.yml (1)

111-111: LGTM! Acronym exception correctly added with good cross-file consistency.

The addition of "RFC" is correctly alphabetized. Good consistency ensuring RFC is added to both the acronyms and headings exception lists.


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.

Copy link
Member

@alexakreizinger alexakreizinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@esmerel esmerel merged commit 18ef3bb into master Dec 18, 2025
8 checks passed
@esmerel esmerel deleted the lynettemiles/sc-158087/fluent-dictionary-updates branch December 18, 2025 21:28
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.

3 participants