Enrich the doc on docs.rs for pink #1330
Merged
Conversation
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
kvinwang
force-pushed
the
doc-comments
branch
3 times, most recently
from
dfe5dff to
051e111
Compare
h4x3rotab
reviewed
Jul 5, 2023
h4x3rotab
reviewed
Jul 7, 2023
|
@HashWarlock Can you help review on this? |
h4x3rotab
approved these changes
Jul 7, 2023
HashWarlock
reviewed
Jul 7, 2023
| pub fn set_log_handler(contract: AccountId) { | ||
| emit_event::<PinkEnvironment, _>(PinkEvent::SetLogHandler(contract)) | ||
| } | ||
|
|
||
| /// Set the weight of contract used to schedule queries and sidevm vruntime | ||
| /// Set the weight of contract used to schedule queries and sidevm vruntime. (system only) |
There was a problem hiding this comment.
Does vruntime mean something like virtual runtime? I see it used twice.
There was a problem hiding this comment.
Yes. Replaced with virtual runtime.
HashWarlock
reviewed
Jul 7, 2023
| /// - `PinkLogger`: The contract that with a sidevm instance that collect the logs and events | ||
| /// emitted by the ink! contracts in current cluster. | ||
| /// - `ContractDeposit`: The contract that implements the `trait ContractDeposit` which talks | ||
| /// to the pallet PhatKokenomic on Phala chain. |
There was a problem hiding this comment.
Pallet is named PhatTokenomic, right?
HashWarlock
reviewed
Jul 7, 2023
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.
Joshua has already made amazing docs and guides for Phat Contracts in phala-docs.
However, the pink APIs docs was still poor of quality. This PR enrich the API docs of pink-extension on docs.rs.
We can temporarily preview the doc here.