Skip to content

Clarify documentation and rename some variables :) #61

Open
@odrais-amsicorp

Description

@odrais-amsicorp

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions