Example in database.inc doesn't make sense [#2060037]

As part of #1533096: Make includes directory, files starting with D-G pass Coder Review I've noticed:

database.inc

 * @code
 * INSERT INTO {example} (id, uid, path, name) VALUES (1, 2, 'home', 'Home path');
 * @endcode
 * one would instead write:
 * @code
 * $fields = array('nid' => 1, 'title' => 'my title', 'body' => 'my body');
 * db_insert('node')->fields($fields)->execute();
 * @endcode

The example code above doesn't make sense, in the first part of the example we put 4 values into the 'example' table, in the second part of the example we put 3 different fields into a different table.

I suggest changing the second part of the example to match the table and fields in the first part.

I'll post a patch for this in a moment

Comment	File	Size	Author
#1	database.inc_example-2060037-1.patch	949 bytes	sphism

Comments

Comment #0.0

sphism commented 8 August 2013 at 04:24

Issue summary:

View changes

added backlink to original issue

Comment #1

sphism commented 8 August 2013 at 05:04

Status:

Active

» Needs review

Status	File	Size
new	database.inc_example-2060037-1.patch	949 bytes

Here's the new example, which i think makes more sense and is formatted correctly:

@code
 * INSERT INTO {example} (id, uid, path, name) VALUES (1, 2, 'path', 'Name');
 * @endcode
 * one would instead write:
 * @code
 * $fields = array('id' => 1, 'uid' => 2, 'path' => 'path', 'name' => 'Name');
 * db_insert('example')
 *   ->fields($fields)
 *   ->execute();
 * @endcode

Comment #2

longwave

he/him

English

commented 8 August 2013 at 09:50

Status:

Needs review

» Reviewed & tested by the community

That makes much more sense now.

Comment #3

sphism commented 8 August 2013 at 09:58

Great stuff, thanks for reviewing that so quickly @longwave

Comment #4

longwave

he/him

English

commented 8 August 2013 at 10:16

Checked to see if this needs backporting, but in D7 both examples use the node table. This was changed in D8 in #1498674: Refactor node properties to multilingual but the db_insert() example was missed.