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

Improve documentation about when we free memory, resolves #311 #1807

Merged
merged 5 commits into from
Aug 21, 2021

Conversation

benkay86
Copy link
Contributor

Add documentation about when Python memory is actually freed for &PyAny "owned" references and Py<PyAny> smart pointers, see #311. One commit adds breadcrumbs to the API documentation. The other commit adds a chapter to the guide. Edits are welcome!

Copy link
Member

@davidhewitt davidhewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 This additional information is very well-written and I agree it's useful for users. Thanks for taking the time to write this!

Just a few minor suggestions from me...

guide/src/advanced.md Outdated Show resolved Hide resolved
guide/src/memory.md Outdated Show resolved Hide resolved
guide/src/memory.md Outdated Show resolved Hide resolved
guide/src/memory.md Outdated Show resolved Hide resolved
@benkay86
Copy link
Contributor Author

Thanks for catching typos. Added link to Python::new_pool() on docs.rs to the appropriate sentence in the guide. Hopefully got rustdoc tests in a state where github workflows will succeed.

guide/src/memory.md Outdated Show resolved Hide resolved
@davidhewitt davidhewitt merged commit ac4613e into PyO3:main Aug 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants