Skip to content

Bump yard-lint from 1.10.2 to 1.10.3 - #6827

Merged
github-actions[bot] merged 1 commit into
mainfrom
dependabot/bundler/yard-lint-1.10.3
Aug 10, 2026
Merged

Bump yard-lint from 1.10.2 to 1.10.3#6827
github-actions[bot] merged 1 commit into
mainfrom
dependabot/bundler/yard-lint-1.10.3

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Aug 10, 2026

Copy link
Copy Markdown
Contributor

Bumps yard-lint from 1.10.2 to 1.10.3.

Release notes

Sourced from yard-lint's releases.

v1.10.3

  • [Feature] Added Tags/TagSeparator (opt-in, disabled by default, severity convention) - a stricter sibling of Tags/TagGroupSeparator. Where TagGroupSeparator only inserts a blank line between different tag groups (and therefore can never separate two tags of the same type, such as sibling @param tags), TagSeparator requires a blank line between every pair of consecutive tags. Tags listed under the Exempt option may immediately follow the previous tag without a blank line - useful for @option tags, which document keys of a preceding @param hash and read best when clustered directly beneath it. RequireAfterDescription additionally requires a blank line between the description and the first tag.
  • [Feature] Documentation/UndocumentedObjects gained an ExcludedObjects option that matches the fully-qualified name of any object - class, module, method, or constant - via exact names or /regex/ patterns anchored to the full path. This closes a gap where constants could never be excluded: ExcludedMethods matches only the trailing method name and deliberately ignores classes/modules/constants (so a pattern like /cache/ cannot silently suppress a class such as Memcached), which left no way to skip a constant like ATui::Input::KEY_A_Z or to target a single object by its full path. ExcludedObjects (e.g. '/^ATui::Input::KEY_/', 'MyApp::Config::DEFAULTS', or arity notation 'MyApp::Api#call/1') now handles those cases; ExcludedMethods behavior is unchanged (#299).
  • [Feature] Documentation/BlankLineBeforeDefinition gained an IgnoredCommentPatterns option: comment lines matching any configured pattern are not treated as documentation, so a blank line below them is no longer reported as a detached docstring. This resolves false positives on comments that are not docs - commented-out code in a constant block (# KEY_F12 = ... then a blank line then KEY_C_A = ...), # FIXME notes, or section separators - without the linter having to guess which comments are code. Each entry is a /regex/ (matched as a regular expression) or a plain string (matched as a literal at word boundaries, so api does not match inside rapid); invalid regexes are skipped. Genuine detached prose docstrings are still reported. Defaults to empty, so existing behaviour is unchanged (#300).
  • [Bugfix] Documentation/BlankLineBeforeDefinition offenses now carry their validator name. The result builder overrode the shared offense construction but omitted the validator field, so the text output rendered the offense as : Blank line ... with an empty validator slot, leaving no way to tell which validator to disable. The name (Documentation/BlankLineBeforeDefinition) is now populated like every other validator (#300).
  • [Bugfix] Documentation/OrphanedDocComment no longer flags a tagged doc comment above a class variable assignment (@@name = ...) as orphaned. YARD's ClassVariableHandler registers class variables as documentable code objects and attaches the preceding comment to them (a bare @private/@api tag included), so the comment is not dropped - it was only the validator's definition matcher that recognized constants (FOO = ...) but not class variables. Class variable assignments are now recognized as documentable, so # @private/@@logger = ... internal-marker pairs are left alone. Single instance-variable assignments (@cached = ...), which YARD does not document, are still reported.
Changelog

Sourced from yard-lint's changelog.

1.10.3 (2026-08-05)

  • [Feature] Added Tags/TagSeparator (opt-in, disabled by default, severity convention) - a stricter sibling of Tags/TagGroupSeparator. Where TagGroupSeparator only inserts a blank line between different tag groups (and therefore can never separate two tags of the same type, such as sibling @param tags), TagSeparator requires a blank line between every pair of consecutive tags. Tags listed under the Exempt option may immediately follow the previous tag without a blank line - useful for @option tags, which document keys of a preceding @param hash and read best when clustered directly beneath it. RequireAfterDescription additionally requires a blank line between the description and the first tag.
  • [Feature] Documentation/UndocumentedObjects gained an ExcludedObjects option that matches the fully-qualified name of any object - class, module, method, or constant - via exact names or /regex/ patterns anchored to the full path. This closes a gap where constants could never be excluded: ExcludedMethods matches only the trailing method name and deliberately ignores classes/modules/constants (so a pattern like /cache/ cannot silently suppress a class such as Memcached), which left no way to skip a constant like ATui::Input::KEY_A_Z or to target a single object by its full path. ExcludedObjects (e.g. '/^ATui::Input::KEY_/', 'MyApp::Config::DEFAULTS', or arity notation 'MyApp::Api#call/1') now handles those cases; ExcludedMethods behavior is unchanged (#299).
  • [Feature] Documentation/BlankLineBeforeDefinition gained an IgnoredCommentPatterns option: comment lines matching any configured pattern are not treated as documentation, so a blank line below them is no longer reported as a detached docstring. This resolves false positives on comments that are not docs - commented-out code in a constant block (# KEY_F12 = ... then a blank line then KEY_C_A = ...), # FIXME notes, or section separators - without the linter having to guess which comments are code. Each entry is a /regex/ (matched as a regular expression) or a plain string (matched as a literal at word boundaries, so api does not match inside rapid); invalid regexes are skipped. Genuine detached prose docstrings are still reported. Defaults to empty, so existing behaviour is unchanged (#300).
  • [Bugfix] Documentation/BlankLineBeforeDefinition offenses now carry their validator name. The result builder overrode the shared offense construction but omitted the validator field, so the text output rendered the offense as : Blank line ... with an empty validator slot, leaving no way to tell which validator to disable. The name (Documentation/BlankLineBeforeDefinition) is now populated like every other validator (#300).
  • [Bugfix] Documentation/OrphanedDocComment no longer flags a tagged doc comment above a class variable assignment (@@name = ...) as orphaned. YARD's ClassVariableHandler registers class variables as documentable code objects and attaches the preceding comment to them (a bare @private/@api tag included), so the comment is not dropped - it was only the validator's definition matcher that recognized constants (FOO = ...) but not class variables. Class variable assignments are now recognized as documentable, so # @private/@@logger = ... internal-marker pairs are left alone. Single instance-variable assignments (@cached = ...), which YARD does not document, are still reported.
Commits
  • f3ec8b0 v1.10.3 (#305)
  • b9c0b1e Add Tags/TagSeparator validator (#304)
  • 5456e52 Update dependency simplecov to v1.0.3 (#303)
  • 596103c Fix BlankLineBeforeDefinition: add IgnoredCommentPatterns option + missing va...
  • 770574e Add ExcludedObjects option to exclude constants and full-path objects from Un...
  • 1480a4b Update ruby/setup-ruby action to v1.321.0 (#297)
  • f6621b3 Backfill missing gemspec metadata (#296)
  • f46f8de Update ruby setup to v1.320.0 (#294)
  • b6567e1 Update CHANGELOG.md
  • 2ae1a33 Fix OrphanedDocComment false positive on class variable doc comments (#293)
  • Additional commits viewable in compare view

@dependabot dependabot Bot added dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code labels Aug 10, 2026
@github-actions
github-actions Bot enabled auto-merge August 10, 2026 09:54
@codacy-production

codacy-production Bot commented Aug 10, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Bumps [yard-lint](https://github.com/mensfeld/yard-lint) from 1.10.2 to 1.10.3.
- [Release notes](https://github.com/mensfeld/yard-lint/releases)
- [Changelog](https://github.com/mensfeld/yard-lint/blob/master/CHANGELOG.md)
- [Commits](mensfeld/yard-lint@v1.10.2...v1.10.3)

---
updated-dependencies:
- dependency-name: yard-lint
  dependency-version: 1.10.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot force-pushed the dependabot/bundler/yard-lint-1.10.3 branch from 84c353b to 88088e8 Compare August 10, 2026 10:28
@github-actions
github-actions Bot merged commit 8d24b97 into main Aug 10, 2026
15 checks passed
@github-actions
github-actions Bot deleted the dependabot/bundler/yard-lint-1.10.3 branch August 10, 2026 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants