docs(escrow): add rustdoc comments to public getter functions - #393
Open
rushikeshgarad2024-dev wants to merge 1 commit into
Open
rushikeshgarad2024-dev wants to merge 1 commit into
rushikeshgarad2024-dev wants to merge 1 commit into
Conversation
…ergeFi#331) Signed-off-by: rushikeshgarad2024-dev <rushikeshgarad2024@gmail.com>
|
@rushikeshgarad2024-dev is attempting to deploy a commit to the chonilius' projects Team on Vercel. A member of the Team first needs to authorize it. |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #331
Summary
Adds rustdoc doc comments (
///) to the view and getter functions incontracts/escrow/src/lib.rs:get_admin: Documents retrieving admin address orError::NotInitialized.get_oracle: Documents retrieving oracle address orError::NotInitialized.get_treasury: Documents retrieving treasury address orError::NotInitialized.get_fee_bps: Documents retrieving active protocol fee basis points orError::NotInitialized.set_treasury: Documents updating the fee recipient treasury address, and ensures valid closing brace syntax.get_version: Documents returning contract version (defaulting to 0).get_max_sponsors: Documents returning max sponsors limit per escrow.Payout Address (Stellar)
GC5U46IS25KYFKNHDXEHR3KTQB3DVIBM4NW5BH4MVUE2G77STCJP4IHF