Skip to content

Update docs with example #438

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
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update docs with example #438

wants to merge 3 commits into from

Conversation

znichollscr
Copy link

Closes #402

@znichollscr
Copy link
Author

@gaborbernat how is this? Also please let me know if I need to do changelog etc. (if the answer is, 'rtfd', then just tell me that)

gaborbernat
gaborbernat requested changes Aug 22, 2025
View reviewed changes
docs/index.rst
# you will not actually hold the lock forever.
# Instead, the lock is released
# when the created variable is garbage collected.
FileLock(lock_path).acquire()
Copy link
Member

Choose a reason for hiding this comment

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

Can you add a disclaimer that therefore no one ever should use it like this, prefer using the with form.

Copy link
Author

Choose a reason for hiding this comment

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

Done (although on a different line, hope that is ok)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaborbernat gaborbernat gaborbernat requested changes

Requested changes must be addressed to merge this pull request.

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

Successfully merging this pull request may close these issues.

Confusing but perhaps deliberate behaviour ?
2 participants
@znichollscr @gaborbernat