-
Notifications
You must be signed in to change notification settings - Fork 782
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add narrative docs for BoundObject #4703
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I think it's a good idea to add a bit of documentation around this.
Personally I would put this closer to the documentation of IntoPyObject
(in traits.md
), because (at least currently) that's the only place this comes up.
I like the example and wonder whether we should extend it a bit to show a transition from a concrete version of this it, say turning an Vec<u32>
to a Vec<Bound<PyInt>>
, then generalize this to Vec<T>
to a Vec<Bound<T::Target>>
or something, with some type annotation/comments explaining the difference.
Co-authored-by: Icxolu <10486322+Icxolu@users.noreply.github.com>
Good idea! I'll look at expanding it with the concrete example, along with moving this to the docs for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks both, this looks good to me. I'll roll this up now in prep for 0.23 release.
see #4651 (comment)