Exclude magic comments from documentation #3844
Open
+79
−29
Conversation
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
How to use the Graphite Merge QueueAdd the label graphite-merge to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
This commit adds the index configuration to entries which will later be used to fix an issue with magic comments appearing in documentation.
This commit ensures magic comments are excluded from documentation. They were already filtered out when eagerly indexing comments but the same logic wasn't applied when lazily loading comments.
thomasmarshall
force-pushed
the
exclude-magic-comments
branch
from
cb47ea7 to
707c7cc
Compare
vinistock
approved these changes
Nov 28, 2025
| module RubyIndexer | ||
| class Entry | ||
| #: Configuration | ||
| attr_reader :configuration |
Member
There was a problem hiding this comment.
I think we're not using this attr_reader. If that's the case, let's remove it.
alexcrocha
added
the
server
alexcrocha
approved these changes
Dec 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
Closes #3775.
This PR fixes an issue whereby magic comments were not excluded when lazily loaded.
Implementation
I copied the implementation for eagerly loaded comments from here.
In order to do this, I needed the entries to have access to the
magic_comment_regexconfiguration.I opted to pass the index through to the entries, but I'm not sure if that's the best approach—is it part of the public API that plugins use?I'm passing just the configuration through rather than the index.Automated Tests
I have added a test and confirmed it failed before implementing the fix.
Manual Tests