Fix docblock typos in DriverManager docs by CHItA · Pull Request #3834 · doctrine/dbal

CHItA · 2020-01-19T20:48:56Z

Q	A
Type	documentation
BC Break	no
Fixed issues	none

Summary

In the api docs the names of the drivers are incorrect. Also, could someone confirm that the (unstable) annotations are still correct?

morozov · 2020-01-19T21:21:24Z

@CHItA thanks for the update. The ibm_db2 driver is pretty much stable. The (unstable) annotation should definitely be removed from there. As for pdo_oci, it is usable and we continuously test against it. In the end, it's the consumer's call which driver to use.

I'd remove the (unstable) annotation from everywhere and sort the drivers alphabetically.

morozov · 2020-01-19T21:51:45Z

lib/Doctrine/DBAL/DriverManager.php

     *
     * Either 'driver' with one of the following values:
     *
+     *     drizzle_pdo_mysql


Hm… it actually duplicates the keys of the driver map. Would it make sense to reference if using {@link $_driverMap} instead of duplication?

dbal/lib/Doctrine/DBAL/DriverManager.php

Lines 46 to 58 in 3d6d354

private static $_driverMap = [

'pdo_mysql' => PDOMySQLDriver::class,

'pdo_sqlite' => PDOSQLiteDriver::class,

'pdo_pgsql' => PDOPgSQLDriver::class,

'pdo_oci' => PDOOCIDriver::class,

'oci8' => OCI8Driver::class,

'ibm_db2' => DB2Driver::class,

'pdo_sqlsrv' => PDOSQLSrvDriver::class,

'mysqli' => MySQLiDriver::class,

'drizzle_pdo_mysql' => DrizzlePDOMySQLDriver::class,

'sqlanywhere' => SQLAnywhereDriver::class,

'sqlsrv' => SQLSrvDriver::class,

];

True, I am fine with whatever. Although $_driverMap doesn't seem to be listed in the API docs, which I would consider to be quite useful.

One more note, then I'll be happy to push whatever you find to be the best solution:
a) Which one of these would you prefer? Using a {@link $_driverMap} or just linking to the getAvailableDrivers() function which returns the keys of this array.
b) The docblock has no return value annotation so if I'm here, I might as well fix that too. Should I?

Also, what is your commit squashing policy? Three commits feel a bit much for a one line documentation change.

Which one of these would you prefer?

{@link $_driverMap} seems like a more reasonable reference. It contains the actual values we're referring to.

The docblock has no return value annotation […]

Which one?

Also, what is your commit squashing policy? Three commits feel a bit much for a one line documentation change.

We usually squash commits unless they provide additional clarity to the changes (not the case here).

Oh, and getConnection() is missing the return statement.

morozov · 2020-01-22T19:08:15Z

Thanks, @CHItA!

CHItA · 2020-01-22T19:10:10Z

@morozov No worries, thank you for maintaining Doctrine! :)

@greg0ire

Release [2.10.2](https://github.com/doctrine/dbal/milestone/75) 2.10.2 ====== - Total issues resolved: **4** - Total pull requests resolved: **19** - Total contributors: **10** Improvement,Static Analysis --------------------------- - [3964: Mark every exception as immutable](doctrine#3964) thanks to @greg0ire CI,Improvement,Static Analysis ------------------------------ - [3961: Stop relying on the master version of Psalm](doctrine#3961) thanks to @greg0ire - [3951: Setup static analysis with Psalm](doctrine#3951) thanks to @greg0ire - [3799: Upgrade to PHPStan v0.12](doctrine#3799) thanks to @lcobucci Improvement,Logging,Test Suite ------------------------------ - [3957: Reworked LoggingTest to be able to test Statement::executeUpdate()](doctrine#3957) thanks to @morozov CI,Code Style,Improvement,Strict Typing --------------------------------------- - [3955: Remove baseline](doctrine#3955) thanks to @greg0ire Bug,SQLite,Schema Introspection,Schema Managers ----------------------------------------------- - [3937: Column comment incorrectly introspected on SQLite](doctrine#3937) thanks to @morozov Bug,Documentation,Prepared Statements,Query ------------------------------------------- - [3896: Updated documentation for QueryBuilder::execute() return value type](doctrine#3896) thanks to @morozov Bug,Prepared Statements ----------------------- - [3894: Make sure that the $types array has the same keys $params](doctrine#3894) thanks to @morozov - [3893: Ensure the constructor arguments are passed to custom classes](doctrine#3893) thanks to @duncan3dc - [3843: Fix unquoted stmt fragments backslash escaping](doctrine#3843) thanks to @morozov Documentation,Improvement ------------------------- - [3886: Update readme](doctrine#3886) thanks to @greg0ire - [3834: Fix docblock typos in DriverManager docs](doctrine#3834) thanks to @CHItA CI,Improvement,MariaDB,MySQL ---------------------------- - [3884: Use Docker consistently](doctrine#3884) thanks to @greg0ire - [3478: Improve readiness probe stability for containerized databases on CI](doctrine#3478) thanks to @morozov - [3883: Fix broken build](doctrine#3883) thanks to @greg0ire Bug,Documentation,Query,Query Limit/Offset Modification ------------------------------------------------------- - [3842: Fixed the QueryBuilder::setMaxResults() signature to accept NULL](doctrine#3842) thanks to @morozov Bug,Query --------- - [3832: Fix JOIN with no condition bug](doctrine#3832) thanks to @BenMorel Bug,PostgreSQL,Schema Introspection ----------------------------------- - [3821: &doctrine#91;pg&doctrine#93; fix getting table information if search&doctrine#95;path contains escaped schema name](doctrine#3821) thanks to @linniksa Documentation,Improvement,Logging --------------------------------- - [3812: Fix DebugStack#queries docblock type](doctrine#3812) thanks to @ostrolucky Bug,Regression,Schema --------------------- - [3790: fixed unqualified table name of fk constraints when using schemas](doctrine#3790) thanks to @stlrnz and @Alarich # gpg: Signature made Mon Apr 20 19:59:36 2020 # gpg: using DSA key 2C3A645671828132 # gpg: Can't check signature: public key not found # Conflicts: # README.md

morozov added Documentation Improvement labels Jan 19, 2020

morozov reviewed Jan 19, 2020

View reviewed changes

Fix the documentation of the driver option

c12db80

CHItA force-pushed the fix-driver-manager-documentation branch from 3d6d354 to c12db80 Compare January 22, 2020 18:55

morozov approved these changes Jan 22, 2020

View reviewed changes

morozov added this to the 2.10.2 milestone Jan 22, 2020

morozov self-assigned this Jan 22, 2020

morozov merged commit 4343e06 into doctrine:2.10 Jan 22, 2020

CHItA deleted the fix-driver-manager-documentation branch January 22, 2020 19:10

doctrinebot mentioned this pull request Apr 20, 2020

Merge release 2.10.2 into 2.11.x #3968

Merged

github-actions bot locked as resolved and limited conversation to collaborators Aug 5, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix docblock typos in DriverManager docs#3834

Fix docblock typos in DriverManager docs#3834
morozov merged 1 commit intodoctrine:2.10from
CHItA:fix-driver-manager-documentation

CHItA commented Jan 19, 2020

Uh oh!

morozov commented Jan 19, 2020 •

edited

Loading

Uh oh!

morozov Jan 19, 2020

Uh oh!

CHItA Jan 19, 2020

Uh oh!

CHItA Jan 20, 2020

Uh oh!

morozov Jan 21, 2020

Uh oh!

CHItA Jan 22, 2020

Uh oh!

morozov commented Jan 22, 2020

Uh oh!

CHItA commented Jan 22, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	private static $_driverMap = [
	'pdo_mysql' => PDOMySQLDriver::class,
	'pdo_sqlite' => PDOSQLiteDriver::class,
	'pdo_pgsql' => PDOPgSQLDriver::class,
	'pdo_oci' => PDOOCIDriver::class,
	'oci8' => OCI8Driver::class,
	'ibm_db2' => DB2Driver::class,
	'pdo_sqlsrv' => PDOSQLSrvDriver::class,
	'mysqli' => MySQLiDriver::class,
	'drizzle_pdo_mysql' => DrizzlePDOMySQLDriver::class,
	'sqlanywhere' => SQLAnywhereDriver::class,
	'sqlsrv' => SQLSrvDriver::class,
	];

Uh oh!

Conversation

CHItA commented Jan 19, 2020

Summary

Uh oh!

morozov commented Jan 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

morozov Jan 19, 2020

Choose a reason for hiding this comment

Uh oh!

CHItA Jan 19, 2020

Choose a reason for hiding this comment

Uh oh!

CHItA Jan 20, 2020

Choose a reason for hiding this comment

Uh oh!

morozov Jan 21, 2020

Choose a reason for hiding this comment

Uh oh!

CHItA Jan 22, 2020

Choose a reason for hiding this comment

Uh oh!

morozov commented Jan 22, 2020

Uh oh!

CHItA commented Jan 22, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

morozov commented Jan 19, 2020 •

edited

Loading