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

Fix small typo in fungible token freeze docs #4943

Merged
merged 10 commits into from
Jul 6, 2024

Conversation

tsenovilla
Copy link
Contributor

Hi!

In the course of a talk with @shawntabrizi in Singapore, we realized the documentation related to freeze balances' a little bit confusing. It stated that a frozen amount is released at some specified block number, which isn't true in general.

This PR fixes that typo and further specifies that the frozen balance may exceed the available balance, according to what we learned at the PBA. This feature was not specified in the documentation AFAIK.

This is the first time I submit something to the polkadot SDK repo, so please feel free to rephrase the docs I added in case I messed up!

@tsenovilla tsenovilla requested a review from a team as a code owner July 4, 2024 13:03
@cla-bot-2021
Copy link

cla-bot-2021 bot commented Jul 4, 2024

User @tsenovilla, please sign the CLA here.

Copy link
Member

@shawntabrizi shawntabrizi left a comment

Choose a reason for hiding this comment

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

lgtm. thanks!

@shawntabrizi shawntabrizi added A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). T11-documentation This PR/Issue is related to documentation. labels Jul 5, 2024
@paritytech-review-bot paritytech-review-bot bot requested a review from a team July 5, 2024 11:02
Copy link

github-actions bot commented Jul 5, 2024

Review required! Latest push from author must always be reviewed

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
@ggwpez
Copy link
Member

ggwpez commented Jul 6, 2024

Can you still please put a minimal prdoc and record a patch for frame-support? Otherwise it will possibly not be included in the next release.

@ggwpez ggwpez added the T1-FRAME This PR/Issue is related to core FRAME, the framework. label Jul 6, 2024
@tsenovilla
Copy link
Contributor Author

Can you still please put a minimal prdoc and record a patch for frame-support? Otherwise it will possibly not be included in the next release.

Sure! I wasn't aware of this procedure, let me do it later on

Copy link
Contributor Author

@tsenovilla tsenovilla Jul 6, 2024

Choose a reason for hiding this comment

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

@ggwpez would this be correct?

@bkchr
Copy link
Member

bkchr commented Jul 6, 2024

bot fmt

@command-bot
Copy link

command-bot bot commented Jul 6, 2024

@bkchr https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6646352 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 1-aacae689-ac8d-445b-b373-eceed3cbc808 to cancel this command or bot cancel to cancel all commands in this pull request.

@bkchr bkchr enabled auto-merge July 6, 2024 19:50
@command-bot
Copy link

command-bot bot commented Jul 6, 2024

@bkchr Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6646352 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6646352/artifacts/download.

@bkchr bkchr added this pull request to the merge queue Jul 6, 2024
Merged via the queue into paritytech:master with commit 515a9f7 Jul 6, 2024
156 of 160 checks passed
TomaszWaszczyk pushed a commit to TomaszWaszczyk/polkadot-sdk that referenced this pull request Jul 7, 2024
Hi!

In the course of a talk with @shawntabrizi in Singapore, we realized the
documentation related to freeze balances' a little bit confusing. It
stated that a frozen amount is released at some specified block number,
which isn't true in general.

This PR fixes that typo and further specifies that the frozen balance
may exceed the available balance, according to what we learned at the
PBA. This feature was not specified in the documentation AFAIK.

This is the first time I submit something to the polkadot SDK repo, so
please feel free to rephrase the docs I added in case I messed up!

---------

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: command-bot <>
@tsenovilla tsenovilla deleted the tsenovilla/fix-docs-typo branch July 8, 2024 08:46
TarekkMA pushed a commit to moonbeam-foundation/polkadot-sdk that referenced this pull request Aug 2, 2024
Hi!

In the course of a talk with @shawntabrizi in Singapore, we realized the
documentation related to freeze balances' a little bit confusing. It
stated that a frozen amount is released at some specified block number,
which isn't true in general.

This PR fixes that typo and further specifies that the frozen balance
may exceed the available balance, according to what we learned at the
PBA. This feature was not specified in the documentation AFAIK.

This is the first time I submit something to the polkadot SDK repo, so
please feel free to rephrase the docs I added in case I messed up!

---------

Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
Co-authored-by: command-bot <>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). T1-FRAME This PR/Issue is related to core FRAME, the framework. T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants