Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document solana_program::instruction #21817

Merged
merged 2 commits into from Dec 14, 2021
Merged

Conversation

brson
Copy link
Contributor

@brson brson commented Dec 12, 2021

Problem

Hackers love docs and they don't get enough of them.

Summary of Changes

This adds docs and examples for everything in the instruction module. Please review the "Specifying account metadata" section closely.

I made the checked_add function hidden as it seems to be intended for internal use.

cc @askibin I appreciated your review of my last doc patch.

@mergify mergify bot added the community Community contribution label Dec 12, 2021
@mergify mergify bot requested a review from a team December 12, 2021 19:43
@brson brson force-pushed the docs-instruction branch 6 times, most recently from 3229d6a to cdcd75c Compare December 12, 2021 22:30
Copy link
Contributor

@CriesofCarrots CriesofCarrots left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple nits, otherwise looks great

sdk/program/src/instruction.rs Outdated Show resolved Hide resolved
sdk/program/src/instruction.rs Outdated Show resolved Hide resolved
sdk/program/src/instruction.rs Outdated Show resolved Hide resolved
Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
@brson
Copy link
Contributor Author

brson commented Dec 14, 2021

Suggestions committed. Thanks for catching my typos. Great eyes.

@CriesofCarrots CriesofCarrots added automerge Merge this Pull Request automatically once CI passes v1.9 labels Dec 14, 2021
Copy link
Contributor

@CriesofCarrots CriesofCarrots left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, thank you!

@codecov
Copy link

codecov bot commented Dec 14, 2021

Codecov Report

Merging #21817 (b53b006) into master (a400b5e) will increase coverage by 0.0%.
The diff coverage is 94.4%.

@@           Coverage Diff           @@
##           master   #21817   +/-   ##
=======================================
  Coverage    81.3%    81.3%           
=======================================
  Files         516      516           
  Lines      144033   144033           
=======================================
+ Hits       117139   117144    +5     
+ Misses      26894    26889    -5     

@mergify mergify bot merged commit dcb5849 into solana-labs:master Dec 14, 2021
mergify bot pushed a commit that referenced this pull request Dec 14, 2021
* Document solana_program::instruction

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit dcb5849)
mergify bot added a commit that referenced this pull request Dec 15, 2021
* Document solana_program::instruction

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit dcb5849)

Co-authored-by: Brian Anderson <andersrb@gmail.com>
@brooksprumo brooksprumo mentioned this pull request Jan 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2022

This PR has been automatically locked since there has not been any activity in past 14 days after it was merged.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automerge Merge this Pull Request automatically once CI passes community Community contribution locked PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants