Add docstrings to members of typing#198
Closed
sleiner-v wants to merge 1 commit into
Closed
Conversation
Implementations of StarlarkValue::documentation() derived from actual Rust docstrings are not automatically generated by #[starlark_value], but instead by #[starlark_module]. The typing module does not use #[starlark_module], and introducing a second spot where Rust docstrings would be picked up for StarlarkDocumentation seemed confusing, so this patch hand-rolls the function implementations.
meta-cla
Bot
added
the
CLA Signed
|
This pull request has been imported. If you are a Meta employee, you can view this in D107654015. (Because this pull request was imported automatically, there will not be any future comments.) |
ndmitchell
approved these changes
Jun 5, 2026
ndmitchell
left a comment
ndmitchell
left a comment
Contributor
There was a problem hiding this comment.
Review automatically exported from Phabricator review in Meta.
meta-codesync Bot
pushed a commit
to facebook/buck2
that referenced
this pull request
Jun 8, 2026
Summary: Implementations of StarlarkValue::documentation() derived from actual Rust docstrings are not automatically generated by #[starlark_value], but instead by #[starlark_module]. The typing module does not use #[starlark_module], and introducing a second spot where Rust docstrings would be picked up for StarlarkDocumentation seemed confusing, so this patch hand-rolls the function implementations. X-link: facebook/starlark-rust#198 Reviewed By: ndmitchell Differential Revision: D107654015 fbshipit-source-id: e3414e6e9f1d6d885096bb3d53c88f83745046d1
|
This pull request has been merged in b7034f9. |
|
This pull request has been reverted by aa3e5bf. |
Contributor
Author
Unfortunately, I cannot see why it was reverted. @ndmitchell can you share any details? |
Contributor
|
@sleiner-v it broke some tests - not totally sure why. Attempting to fix and reland. |
Contributor
|
I put it back again as b96627e. Hoping that it doesn't get reverted again. |
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
2 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.
Implementations of
StarlarkValue::documentation()derived from actual Rust docstrings are not automatically generated by#[starlark_value], but instead by#[starlark_module]. The typing module does not use#[starlark_module], and introducing a second spot where Rust docstrings would be picked up forStarlark::documentation()seemed confusing, so this patch hand-rolls the function implementations.