Skip to content

Conversation

andreitrand
Copy link

@andreitrand andreitrand commented Sep 12, 2025

Added several documentation-related fixes. In more detail:

  • Typo fixes and rephrasing inside the pallet's Readme file
  • Various code comment fixes

Related issue: N/A

@andreitrand andreitrand added R0-no-crate-publish-required The change does not require any crates to be re-published. T11-documentation This PR/Issue is related to documentation. labels Sep 12, 2025
@paritytech-workflow-stopper
Copy link

All GitHub workflows were cancelled due to failure one of the required jobs.
Failed workflow url: https://github.com/paritytech/polkadot-sdk/actions/runs/17673524594
Failed job name: fmt

@sigurpol
Copy link
Contributor

thanks for the PR! Whereas all changes make sense, I would suggest to focus not on staking pallet but on staking-async which is the new kid in town.
Reason being that with AHM we are in the process of migrating staking on Westend (done), Kusama (beginning of October), Polkadot (beginning of November) to AH where we use staking-async.

AFAIK there is (or was and maybe it's on hold due to other priorities) an effort by @kianenigma and @Ank4n to have the new staking async pallet thoroughly documented. Kian can surely tell you more about it

@andreitrand andreitrand force-pushed the andreitrand-staking-readme-and-comments-fixes branch from 8f9a5c8 to 963dacc Compare September 12, 2025 12:07
Copy link
Contributor

@sigurpol sigurpol left a comment

Choose a reason for hiding this comment

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

All changes make definitely sense. As per #9728 (comment), I think though that we should focus on the documentation of staking-async instead (but it doesn't hurt to have fixes in the legacy one ofc)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-no-crate-publish-required The change does not require any crates to be re-published. T11-documentation This PR/Issue is related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants