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

Clarify documentation and rename some variables :) #61

Open
odrais-amsicorp opened this issue Sep 9, 2024 · 0 comments
Open

Clarify documentation and rename some variables :) #61

odrais-amsicorp opened this issue Sep 9, 2024 · 0 comments

Comments

@odrais-amsicorp
Copy link

While reviewing the code, I was confused by the comment documentation in Handler.php. It was calculating the number of write lock tries using _breakAfter and _failAfter values correctly, but the comment stated it was in seconds.

The calculation actually returns the number of write lock tries before trying to break the lock and failing to break the lock, respectively. So I've adjusted the documentation appropriately.

I also renamed some properties so it's clearer what they are. And created a utility function to return the number of write lock tries per second.

The PR is here: #60 .

Not necessarily a bug fix, but I believe it's a quality of life fix.

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

No branches or pull requests

1 participant