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.

Sign up for GitHub

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

Jump to bottom

docs: extend documentation on Sync and thread-safety #4695

Merged
merged 9 commits into from
Nov 15, 2024
Merged

docs: extend documentation on Sync and thread-safety #4695

merged 9 commits into from
Nov 15, 2024

Conversation

davidhewitt
Copy link
Member

Docs for Sync. This seems to be shaping up ok, I will push to the blank sections tonight hopefully.

ngoldbaum
ngoldbaum reviewed Nov 11, 2024
View reviewed changes
Copy link
Contributor

@ngoldbaum ngoldbaum left a comment

Choose a reason for hiding this comment

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

Looks great so far, just have some minor writing style comments

guide/src/class/thread-safety.md Outdated Show resolved Hide resolved
guide/src/class/thread-safety.md Outdated Show resolved Hide resolved
guide/src/migration.md Outdated Show resolved Hide resolved
mejrs
mejrs reviewed Nov 11, 2024
View reviewed changes
Copy link
Member

@mejrs mejrs left a comment

Choose a reason for hiding this comment

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

Looks good, so far, there are a few things I'd word differently but feel free to disregard if you prefer your own way.

guide/src/class.md Outdated Show resolved Hide resolved
guide/src/class.md Outdated Show resolved Hide resolved
guide/src/class/thread-safety.md Outdated Show resolved Hide resolved
@davidhewitt @alex
Update guide/src/class/thread-safety.md
bfdd00e 
Co-authored-by: Alex Gaynor <alex.gaynor@gmail.com>
@davidhewitt davidhewitt changed the title guide: extend documentation on Sync and thread-safety docs: extend documentation on Sync and thread-safety Nov 11, 2024
davidhewitt and others added 4 commits November 11, 2024 19:58
@davidhewitt @mejrs @ngoldbaum
Apply suggestions from code review
8352396 
Co-authored-by: Bruno Kolenbrander <59372212+mejrs@users.noreply.github.com>
Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
@davidhewitt
threadsafe -> thread-safe
610e23e
@davidhewitt
datastructure -> data structure
36daecf
@davidhewitt
fill out missing sections
eaf3b52
@davidhewitt davidhewitt marked this pull request as ready for review November 11, 2024 20:29
@davidhewitt
Copy link
Member Author

Thanks all for the reviews, much appreciated 🙏

I have pushed a bit of copy to complete the blank sections. I think while this is not perfect, we at least now have some discussion of the topic so I'm inclined to merge and get on with releasing 0.23. We can iterate further in patch releases if needed, and also as we explore alternative #[pyclass] locking options I think we will end up re-writing some of this stuff in future too.

@davidhewitt davidhewitt mentioned this pull request Nov 11, 2024
Merged
5 tasks
@davidhewitt davidhewitt added this pull request to the merge queue Nov 15, 2024
Merged via the queue into PyO3:main with commit e7ec730 Nov 15, 2024
46 checks passed
@davidhewitt davidhewitt deleted the sync-docs branch November 15, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mejrs mejrs mejrs left review comments

@alex alex alex left review comments

@ngoldbaum ngoldbaum ngoldbaum approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@davidhewitt @alex @ngoldbaum @mejrs