Repository navigation
rustdoc: Fix doctest line computation - #164770
Open
GuillaumeGomez wants to merge 2 commits into
Open
GuillaumeGomez wants to merge 2 commits into
GuillaumeGomez wants to merge 2 commits into
Conversation
…s only called by the first
rustbot
added
A-run-make
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
fix-doctest-line
branch
from
October 23, 2026 08:15
958d337 to
0f48e29
Compare
This branch has not been deployed
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
4 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.
Fixes #164685.
Before going any further: all I describe is done for doctests only. The other doc comments processing remains unchanged.
In case you empty lines, code comments or anything else not taken into account in the current doc string, the doctest line number is wrong. So to fix that, whenever there is a gap between two doc strings, I add empty lines in the doc strings.
All fixed, except now, when we want to emit a warning for a line inside a doctest, we also need this code to take this extra content into account. So I added a
Vec<Range>which keeps the position of each doc fragment. So when we know the line we're looking for, we get the index of the range which contains it, and then we get the corresponding doc fragment's span.All the ui test changes are because it was actually an old bug, so it's fixed. Unexpected positive side-effect I guess. ^^'
r? @Urgau