Adopt the yard-lint 1.10 documentation standard - #943
Merged
Conversation
Bring rdkafka-ruby in line with the karafka/mensfeld yard-lint standard: - Bump yard-lint 1.4.0 -> 1.10.2 (Gemfile.lint.lock) - Enable new cops as errors: - Documentation/DuplicateNamespaceComment - Documentation/UnderfilledLines (MaxLength 100, matching RuboCop Layout/LineLength) - Documentation/LineLength (MaxLength 100) - Documentation/TextSubstitution (em/en-dash -> hyphen) - Promote Tags/ExampleSyntax from warning to error - Expand Tags/Order to the ecosystem-wide order (param, option, yield*, return, raise, see, example, note, todo) - Fix all resulting documentation offenses: reflow over-long doc lines and underfilled paragraphs, reorder tag blocks, and convert two genuinely orphaned FFI attach_function tag comments (@see / @param) to prose. - Express internal class-variable visibility markers with the '@!visibility private' directive instead of the bare '@Private' tag, so YARD keeps hiding them without OrphanedDocComment flagging the doc comment (the tag form is folded onto a class-variable assignment, which the cop treats as orphaned). Comment-only changes in lib/**; no Ruby code was modified. 'bundle exec yard-lint lib' and 'bundle exec rubocop' both pass locally.
mensfeld
force-pushed
the
yard-lint-1.10-standard
branch
from
July 25, 2026 20:42
3bd7b8d to
6d9288a
Compare
mensfeld
marked this pull request as ready for review
July 26, 2026 10:42
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bring rdkafka-ruby in line with the karafka/mensfeld yard-lint standard:
Comment-only changes in lib/**; no Ruby code was modified.
Note: yard-lint 1.10.3 also fixes an OrphanedDocComment false positive on class variable doc comments (mensfeld/yard-lint#293), which rdkafka relies on for its internal '# @Private' + '@@var' markers.