Improve docs

Author: JanJakes

.github/workflows/verify-version.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   verify-version:
-    name: Verify plugin version
+    name: Verify that plugin version matches SQLITE_DRIVER_VERSION constant
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

load.php

@@ -14,7 +14,7 @@
 
 /**
  * Load the "SQLITE_DRIVER_VERSION" constant.
- * This constant needs to be updated whenever the plugin version changes!
+ * This constant needs to be updated on plugin release!
  */
 require_once __DIR__ . '/version.php';
 

tests/WP_SQLite_Information_Schema_Reconstructor_Tests.php

@@ -13,9 +13,6 @@ class WP_SQLite_Information_Schema_Reconstructor_Tests extends TestCase {
 	private $sqlite;
 
 	public static function setUpBeforeClass(): void {
-		// if ( ! defined( 'PDO_DEBUG' )) {
-		// define( 'PDO_DEBUG', true );
-		// }
 		if ( ! defined( 'FQDB' ) ) {
 			define( 'FQDB', ':memory:' );
 			define( 'FQDBDIR', __DIR__ . '/../testdb' );
@@ -30,7 +27,7 @@ public static function setUpBeforeClass(): void {
 			$GLOBALS['wpdb']->show_errors     = true;
 		}
 
-		// Mock symols that are used for WordPress table reconstruction.
+		// Mock symbols that are used for WordPress table reconstruction.
 		if ( ! defined( 'ABSPATH' ) ) {
 			define( 'ABSPATH', __DIR__ );
 		}

version.php

@@ -3,6 +3,6 @@
 /**
  * The version of the SQLite driver.
  *
- * This constant needs to be updated whenever the plugin version changes!
+ * This constant needs to be updated on plugin release!
  */
 define( 'SQLITE_DRIVER_VERSION', '2.1.17-alpha' );

wp-includes/sqlite-ast/class-wp-sqlite-information-schema-reconstructor.php

@@ -80,10 +80,10 @@ public function ensure_correct_information_schema(): void {
 		foreach ( $tables as $table ) {
 			if ( ! in_array( $table, $information_schema_tables, true ) ) {
 				if ( isset( $wp_tables[ $table ] ) ) {
-					// WordPress table.
+					// WordPress core table (as returned by "wp_get_db_schema()").
 					$sql = $wp_tables[ $table ];
 				} else {
-					// Non-WordPress table.
+					// Other table (a WordPress plugin or unrelated to WordPress).
 					$sql = $this->generate_create_table_statement( $table );
 				}
 				$ast = $this->driver->parse_query( $sql );
@@ -140,10 +140,6 @@ private function get_information_schema_table_names(): array {
 	/**
 	 * Generate a MySQL CREATE TABLE statement from an SQLite table definition.
 	 *
-	 * This method generates a MySQL CREATE TABLE statement for a given table name.
-	 * It retrieves the column information from the SQLite database and generates
-	 * a CREATE TABLE statement that can be used to create the table in MySQL.
-	 *
 	 * @param  string $table_name The name of the table.
 	 * @return string             The CREATE TABLE statement.
 	 */

wp-includes/sqlite/db.php

@@ -8,7 +8,6 @@
 
 /**
  * Load the "SQLITE_DRIVER_VERSION" constant.
- * This constant needs to be updated whenever the plugin version changes!
  */
 require_once dirname( __DIR__, 2 ) . '/version.php';