Handles Pallet Documentation Improvement #1984
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
wilwade
commented
May 24, 2024
| //! | ||
| //! ## Overview | ||
| //! ## Shuffled Sequences |
There was a problem hiding this comment.
Added in a rust only section on the shuffled sequences. They are just odd without that extra context.
wilwade
commented
May 24, 2024
| | Get Handle by MSA Id | Returns the Display Handle and the block it was claimed | `msaIdToDisplayName` | 29 | | ||
| | Get MSA Id by canonical string and suffix | Uses the stored canonical lookup string NOT the display handle | `canonicalBaseHandleAndSuffixToMSAId` | 29 | | ||
|
|
||
| See the [Rust Docs](https://frequency-chain.github.io/frequency/pallet_handles/pallet/storage_types/index.html) for additional state queries and details. |
There was a problem hiding this comment.
Yes, I left out the canonical to suffix index. It just doesn't make sense for anyone to really use it directly, but that's why we always have this line.
25 tasks
Codecov ReportAll modified and coverable lines are covered by tests ✅
|
wilwade
requested review from
a team,
mattheworris,
enddynayn,
aramikm,
claireolmstead and
JoeCap08055
and removed request for
a team
claireolmstead
approved these changes
May 29, 2024
enddynayn
reviewed
May 30, 2024
enddynayn
reviewed
May 30, 2024
enddynayn
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 30, 2024
JoeCap08055
reviewed
May 31, 2024
JoeCap08055
reviewed
May 31, 2024
Co-authored-by: Joe Caputo <[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.
Goal
The goal of this PR is to improve the documentation of the Pallets and make that documentation be able to be used on docs.frequency.xyz.
Part of frequency-chain/docs#59
Discussion
Screenshot