chore: update documentation for functions #8353
Conversation
PaddyMc
added
V:state/compatible/backport
WalkthroughThe recent updates focus on refining the Changes
Poem
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
x/smart-account/authenticator/signature_authenticator.go (1)
Line range hint
82-82: Consider re-adding or improving the documentation forOnAuthenticatorAdded.The removed comment provided clarity on the method's behavior when no data is passed. It's important for maintainability and understanding to have clear documentation, especially for public methods.
x/smart-account/keeper/keeper.go
Outdated
| @@ -106,7 +106,7 @@ func (k Keeper) GetSelectedAuthenticatorData( | |||
| } | |||
|
|
|||
| // GetInitializedAuthenticatorForAccount returns a single authenticator for the account | |||
| // this function relies in GetAuthenticatorDataForAccount, this function calls | |||
| // this function relies in GetSelectedAuthenticatorData, this function calls | |||
There was a problem hiding this comment.
Still typo, "this function relies in X," doesn't make sense. I'm also not sure if the top line is supposed to continue on to the second line or if its a new sentence.
There was a problem hiding this comment.
Thanks for the review:
Updated to be:
// GetInitializedAuthenticatorForAccount returns a single initialized authenticator for the account.
// It fetches the authenticator data from the store, gets the authenticator struct from the manager, then calls initialize on the authenticator data
* chore: update documentation for functions * chore: update comment to make more sense * chore: update comment again * chore: fix spelling (cherry picked from commit a716aac) # Conflicts: # x/smart-account/keeper/keeper.go
What is the purpose of the change
Update documentation for functions based on audit feedback