docs(macros): add panic and error documentation to generated clients#1676
Open
respp wants to merge 8 commits into
Open
docs(macros): add panic and error documentation to generated clients#1676respp wants to merge 8 commits into
respp wants to merge 8 commits into
Conversation
leighmcculloch
left a comment
leighmcculloch
left a comment
Member
There was a problem hiding this comment.
Thank you! A couple asks inline.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation comments to generated client methods explaining their panic and error behavior. The changes improve developer experience by clearly documenting when methods may panic versus when they return errors.
Changes:
- Added panic documentation to regular client methods (lines 236, 263)
- Added error handling documentation to try_ client methods (lines 249, 297)
Author
|
Hi @leighmcculloch, I've updated the documentation following the standards for the # Panics and # Errors headings. Additionally, I noticed that the function returns Ok(Err(...)) when a type conversion fails. |
leighmcculloch
approved these changes
Jan 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#1612