Skip to content

Document the 3.0 driver API - #477

Draft
JanJakes wants to merge 5 commits into
trunkfrom
docs-fixes
Draft

Document the 3.0 driver API#477
JanJakes wants to merge 5 commits into
trunkfrom
docs-fixes

Conversation

@JanJakes

@JanJakes JanJakes commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

This PR prepares the repository's documentation and non-functional metadata for the 3.0 release:

  • Driver documentation: Adds a focused package README covering the overview, requirements, usage, DSN format, connection options, compatibility limits, and development workflow. It also documents the public exception and driver accessor in source.
  • Package status and naming: Marks the MySQL proxy as experimental and replaces the stale "WP SQLite Driver" name with "MySQL on SQLite."
  • Release and source documentation: Corrects the release command and branch naming, outdated option and drop-in metadata, inaccurate class documentation, and spelling and grammar errors.
  • Obsolete annotations: Removes @since and @package annotations throughout the repository.

Why

Version 3.0 establishes a well-defined PDO-compatible API. Documenting its entry points, connection format, configuration, and limitations makes that contract discoverable outside source docblocks, while the remaining cleanup removes stale or misleading information before the release is tagged.

These changes do not alter runtime behavior.

@JanJakes
JanJakes force-pushed the docs-fixes branch 3 times, most recently from 3ddf87c to 8734b2c Compare August 6, 2026 14:07
@JanJakes JanJakes mentioned this pull request Aug 6, 2026
11 tasks
@JanJakes
JanJakes force-pushed the docs-fixes branch 4 times, most recently from 5f4cbe7 to 07d2458 Compare August 6, 2026 16:09
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

Successfully merging this pull request may close these issues.

1 participant