Add more sysvar API docs #26849
Merged
Add more sysvar API docs #26849
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
|
The CI sanity check is tripping on |
|
I'll think about other ways to present those examples. |
Ah, yeah, our println net is too broad. We ought to allow them in docs. I'll see how tedious that would be to update. |
|
@CriesofCarrots i just removed the printlns from the examples |
|
Great reviews, thanks. |
|
CI failure is a rustsec advisory unrelated to this patch. |
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
CriesofCarrots
previously approved these changes
Aug 15, 2022
CriesofCarrots
force-pushed
the
docs-sysvar
branch
from
f245f9f to
a3f65d2
Compare
mergify
bot
dismissed
CriesofCarrots’s stale review
Pull request has been modified.
xiangzhu70
pushed a commit
to xiangzhu70/solana
that referenced
this pull request
Aug 17, 2022
* Add more sysvar API docs * Remove println from examples * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/clock.rs Co-authored-by: Tyera Eulberg <[email protected]> * Fix docs for ACCOUNT_STORAGE_OVERHEAD * Update sdk/program/src/epoch_schedule.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/sysvar/slot_hashes.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/sysvar/slot_history.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/sysvar/slot_history.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/program/src/sysvar/mod.rs Co-authored-by: Tyera Eulberg <[email protected]> * Fix docs for DEFAULT_LEADER_SCHEDULE_SLOT_OFFSET * Fix recent_blockhash short description * Fix whitespace Co-authored-by: Tyera Eulberg <[email protected]>
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
More docs needed.
Summary of Changes
This adds documentation to the sysvar module and its submodules, to the data types and supporting functions associated with each sysvar. It moves the crate-level sysvar docs into the sysvar module.