The page should include a link to documentation for the options.

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Postponed

The real problem is that the Database and DatabaseConnection object documentation is not currently displayed on api.drupal.org, which is a separate and known issue in the API module. Once that is done, then the doc for the db_select() function should link to the spot in DatabaseConnection where the options array is documented.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: Documentation problem with db_select » db_select() doc header needs to link to $options doc
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: db_select() doc header needs to link to $options doc » $options param for all the database functions needs explanation
Status: Postponed » Active

Yeah... Once the SelectQuery object is available on api.drupal.org, we should be mostly OK on this.

However, I do think that the Database Abstraction Layer page needs to explain $options. This is a common argument on many of the functions, and it is never explained anywhere, that I can see.

Actually, that page is kind of a mess and needs cleanup in general...

http://api.drupal.org/api/group/database/7

sbrattla’s picture

sbrattla commented

This is still an issue...can't see anywhere what $options are good for.

Status: Active » Closed (outdated)

Automatically closed because Drupal 7 security and bugfix support has ended as of 5 January 2025. If the issue verifiably applies to later versions, please reopen with details and update the version.