Skip to content
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

Overview of pointer types and related traits #789

Closed
birkenfeld opened this issue Mar 3, 2020 · 1 comment · Fixed by #801
Closed

Overview of pointer types and related traits #789

birkenfeld opened this issue Mar 3, 2020 · 1 comment · Fixed by #801

Comments

@birkenfeld
Copy link
Member

When diving deeper into the PyO3 docs, I'm always flattened by the sheer number of smart pointer types and related traits. I get that most of them are necessary, and some of them may be remnants that are on the way out, but it's still overwhelming, especially once you start playing tetris with those types, trying to get the result you need. The guide doesn't help in that regard.

I propose (and volunteer to draft, as far as I understand it) a table-like list of those traits, their approximate meaning, and when to use them.

It can be located in the guide, or in the API docs, as you prefer. But wherever it is, it should be linked to from every mentioned type's API docs, and the explanations should be made consistent.

@davidhewitt
Copy link
Member

davidhewitt commented Mar 4, 2020

Thanks. I think something like this is probably best suited for the guide. Probably with a link to it also from the module documentation frontpage.

If during your audit you have any proposals for simplifying the trait/type taxonomy, we'd be very willing to hear them.

(Also see #687 which discusses one possible simplification.)

birkenfeld added a commit to birkenfeld/pyo3 that referenced this issue Mar 12, 2020
birkenfeld added a commit to birkenfeld/pyo3 that referenced this issue Mar 13, 2020
fixes PyO3#789

Co-Authored-By: David Hewitt <[email protected]>
Co-Authored-By: Yuji Kanagawa <[email protected]>
birkenfeld added a commit to birkenfeld/pyo3 that referenced this issue Mar 13, 2020
fixes PyO3#789

Co-Authored-By: David Hewitt <[email protected]>
Co-Authored-By: Yuji Kanagawa <[email protected]>
kngwyu added a commit that referenced this issue Mar 16, 2020
* book: add type overview

fixes #789

Co-Authored-By: David Hewitt <[email protected]>
Co-Authored-By: Yuji Kanagawa <[email protected]>

* Add concrete pointer types to the list.

* Add suggestions from @kngwyu

Co-authored-by: David Hewitt <[email protected]>
Co-authored-by: Yuji Kanagawa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants