autodoc: Lookup file-as-a-struct doctests using the stem of the filename #23615
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
This is not a perfect solution and relies on the convention that file-as-a-struct types have the same file name as the type name. Fixes ziglang#23614
alexrp
reviewed
Apr 21, 2025
Comment on lines
+540
to
+541
| // TODO: Support for doctests on file-as-a-struct types without using | ||
| // the filename to find the associated test. |
There was a problem hiding this comment.
#23614 is the relevant issue until this is merged. If this is merged, I'll open a separate issue for this TODO.
To be clear, this TODO would be relevant for something like:
// Foo.zig
const Bar = @This();
test Bar {
// ...
}After this PR, this doctest will still fail to be found, since it only looks for Foo (based on the filename).
There was a problem hiding this comment.
What I meant is that the TODO should be replaced with an issue link.
There was a problem hiding this comment.
It's awkward because that issue is sort of in limbo--it only needs to exist if this PR is merged.
Happy to open an issue and replace the TODO with a link if I can get confirmation that this PR is going to be merged.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is not a perfect solution and relies on the convention that file-as-a-struct types have the same file name as the type name. Fixes #23614
Example with FixedBufferAllocator:
Primarily motivated by #23613 which adds a doctest for
FailingAllocator.