Fix missing solana_sdk module docs #24577
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #24577 +/- ##
=======================================
Coverage 82.0% 82.0%
=======================================
Files 593 593
Lines 164346 164346
=======================================
+ Hits 134826 134886 +60
+ Misses 29520 29460 -60 |
jstarry
added
automerge
|
Thanks for the fix! |
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
Apr 22, 2022
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
Jun 29, 2022
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
Jun 30, 2022
jeffwashington
pushed a commit
to jeffwashington/solana
that referenced
this pull request
Jun 30, 2022
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.
Problem
The API docs for solana_sdk are missing several modules.
Summary of Changes
As described in #23326 (comment), this is happening because of an interaction that I don't fully understand between reexports in
solana_program::example_mocks::solana_sdkand similar reexports insolana_sdk. Essentially, in this case rustdoc appears to choose the first reexport it finds to document, and leaves subsequent reexports undocumented.Reordering the declaration of
solana_program::example_mockscauses rustdoc to choose to document the reexports insolana_sdk.This is a hack, and this patch documents it as such. It may be possible to fix within rustdoc itself, but that is not clear.
Fixes #23326