Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Add a note with more info about num_slashing_spans for the call withdraw_unbonded in the Staking pallet. #11714

Closed
IkerAlus opened this issue Jun 20, 2022 · 0 comments · Fixed by #14185
Assignees
Labels
I6-documentation Documentation needs fixing, improving or augmenting.

Comments

@IkerAlus
Copy link

It would be nice to add a note or further explanation for the documentation around the input num_slashing_spans for the call withdraw_unbonded in the Staking pallet.

Tools offering staking services have asked about what is the right value to input for withdraw_unbonded assuming they had to use an exact number of slashing spans to remove. However, as far as I understand, this input doesn't affect any state change/logic in the call, it is only a thumbs up/down on whether to proceed with the deletion of slashing spans knowing there is enough fee to pay for it. A sentence stating this point as a note would be enough to avoid future confusion.

@github-actions github-actions bot added the J2-unconfirmed Issue might be valid, but it’s not yet known. label Jun 20, 2022
@kianenigma kianenigma added I6-documentation Documentation needs fixing, improving or augmenting. and removed J2-unconfirmed Issue might be valid, but it’s not yet known. labels May 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
I6-documentation Documentation needs fixing, improving or augmenting.
Projects
Status: Done
3 participants