php / php/doc-en

SQLite3::busyTimeout documentation incomplete

Open
#3,196 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Extension: sqlite3 good first issue
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

From manual page: https://php.net/sqlite3.busytimeout


SQLite3::busyTimeout — Sets the busy connection handler

Sets a busy handler that will sleep until the database is not locked or the timeout is reached.

"busy connection handler" is not adequately explained on the documentation web-page. Is the handler a callback the user must implement? Is it a built-in feature? How do we interact with this handler? What happens if the database is still locked after the timeout? Is an exception thrown? What is the default timeout value? These important details were omitted from this documentation page. Respectfully, please understand that not everyone has the detailed knowledge of SQLite3 or PHP internals to fully understand the PHP source code.

Returns true on success, or false on failure.

This also could be clearer. Does this mean:

"Returns true if timeout is successfully set, or false on failure" ?

Thanks.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SQLite3::busyTimeout manual page at https://php.net/sqlite3.busytimeout and verify the omitted behavior using the PHP or SQLite3 references mentioned in the issue. Done means the page explains the busy handler, timeout behavior, default value, failure outcome, and the meaning of the return value.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.