Improve documentation for Signature, Volatility, and TypeSignature #17264
Conversation
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
github-actions
bot
added
logical-expr
Jefffrey
reviewed
Aug 21, 2025
2010YOUY01
reviewed
Aug 21, 2025
Co-authored-by: Jeffrey Vo <[email protected]>
Co-authored-by: Jeffrey Vo <[email protected]>
|
Thank you @Jefffrey and @2010YOUY01 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Which issue does this PR close?
Utf8Viewfor more args ofregexp_replace#17195Rationale for this change
While reviewing #17195 from @mbutrovich and other recent PRs related to type signatures, I believe the current behavior and implications of TypeSignatures is not clear; I think it is especially confusing to understand what "supported" means
Thus I would like to improve the docs to help
What changes are included in this PR?
Improve the documentation for type signatures in general to explain what they mean and the implications better.
Are these changes tested?
By CI
Are there any user-facing changes?
Some better docs and examples