Add docs for the builtin programs #10359
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
|
💔 Unable to automerge due to CI failure |
solana-grimes
removed
the
automerge
|
💔 Unable to automerge due to CI failure |
solana-grimes
removed
the
automerge
mergify bot
pushed a commit
that referenced
this pull request
Jun 2, 2020
* Add docs for the builtin programs * Cleanup (cherry picked from commit 8c3ad85)
solana-grimes
pushed a commit
that referenced
this pull request
Jun 2, 2020
danpaul000
pushed a commit
to danpaul000/solana
that referenced
this pull request
Jul 8, 2020
* Add docs for the builtin programs * Cleanup
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 builtin programs are currently well-documented in the source code, but those are difficult to find.
Summary of Changes
Add a doc that connects the dots. Linking to the Rust docs is less than ideal, but didn't want to duplicate any content and see one of the two bitrot. Also, although those are docs of Rust enums, is actually declarative enough that it is a decent language-agnostic description of the binary format.