Skip to content

Schemas Pallet Documentation#1968

Merged
wilwade merged 6 commits intomainfrom
docs/schemas
May 15, 2024
Merged

Schemas Pallet Documentation#1968
wilwade merged 6 commits intomainfrom
docs/schemas

Conversation

@wilwade
Copy link
Collaborator

@wilwade wilwade commented May 10, 2024

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

  • Schemas Pallet

@wilwade wilwade requested review from a team, JoeCap08055, aramikm, claireclark1, enddynayn, jeanettedepatie, mattheworris, p5150j and shannonwells and removed request for a team May 10, 2024 16:47
@codecov
Copy link

codecov bot commented May 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
common/primitives/src/schema.rs 58.75% <ø> (ø)
pallets/schemas/src/lib.rs 78.88% <100.00%> (ø)

Copy link
Collaborator

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

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

Questions and suggested changes

| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `set_max_schema_model_bytes`<br />Governance action to alter the maximum byte length of Schema models | Governance | Tokens | [`SchemaMaxSizeChanged`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaMaxSizeChanged) | 1 |
| `propose_to_create_schema_v2`<br />Creates a Council proposal a new schema to the Frequency Council | Token Account | Tokens | [`Proposed`](https://paritytech.github.io/polkadot-sdk/master/pallet_collective/pallet/enum.Event.html#variant.Proposed) | 66 |
| `create_schema_via_governance_v2`<br />Governance called version of `create_schema_v3` | Frequency Council | Tokens | [`SchemaCreated`](https://frequency-chain.github.io/frequency/pallet_schemas/pallet/enum.Event.html#variant.SchemaCreated) | 66 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure how else to word this but it's awkward and unclear. At any rate if you left it, it should be "Governance-called"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I had trouble with it as well. Swapped to Governance action like the set_max_schema_model_bytes has. How does that work?

wilwade and others added 2 commits May 14, 2024 08:47
Co-authored-by: Shannon Wells <shannonwells@users.noreply.github.com>
@wilwade wilwade requested a review from shannonwells May 14, 2024 15:44
Copy link
Collaborator

@saraswatpuneet saraswatpuneet left a comment

Choose a reason for hiding this comment

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

Lgtm

@wilwade wilwade requested a review from JoeCap08055 May 14, 2024 16:26
Copy link
Collaborator

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

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

🚢 it

@wilwade wilwade enabled auto-merge (squash) May 14, 2024 19:14
@wilwade wilwade requested a review from JoeCap08055 May 14, 2024 20:55
@wilwade wilwade merged commit 857169d into main May 15, 2024
@wilwade wilwade deleted the docs/schemas branch May 15, 2024 11:24
shannonwells added a commit that referenced this pull request May 16, 2024
# 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
- Schemas Pallet

---------

Co-authored-by: Shannon Wells <shannonwells@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants