WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 7 years ago

Last modified 6 years ago

#2474 closed defect (bug) (fixed)

Inline documentation for wpdb

Reported by: masquerade Owned by:
Milestone: 2.1 Priority: normal
Severity: normal Version: 2.0.1
Component: Administration Keywords: phpdoc has-patch commit
Focuses: Cc:

Description

As per the hackers thread. Against latest SVN revision

Attachments (4)

wpdb-comments.diff (6.1 KB) - added by masquerade 8 years ago.
wpdb-comments-2.diff (6.1 KB) - added by masquerade 8 years ago.
wpdb-comments-3.diff (6.1 KB) - added by masquerade 8 years ago.
inline-docs-wpdb.diff (6.2 KB) - added by davidhouse 8 years ago.

Download all attachments as: .zip

Change History (12)

masquerade8 years ago

comment:1 dto8 years ago

Should the @return line for the escape function read

@return string query safe string

or am I missing something?

comment:2 MichaelH8 years ago

  • Keywords inline-docs added

comment:3 masquerade8 years ago

Here's a newer patch, with a few minor changes, mainly that I changed an int to string for the type for some methods, as I didn't realize the constants were declared to be strings.

masquerade8 years ago

comment:4 masquerade8 years ago

Here's a newer patch, with a few minor changes, mainly that I changed an int to string for the type for some methods, as I didn't realize the constants were declared to be strings, and fixed a few minor typos in the 3rd and final patch.

masquerade8 years ago

davidhouse8 years ago

comment:5 davidhouse8 years ago

  • Keywords commit added

I changed a few things:

  • Offsets ($x, $y are parameters to some functions) have been explained more clearly.
  • Docs for get_col_info are complete.

comment:6 ryan7 years ago

[4549] gets most of this in but some bits of the patch didn't apply. Anyone care to provide and updated patch?

comment:7 matt7 years ago

  • Resolution set to fixed
  • Status changed from new to closed

When there are more docs we can open new tickets.

comment:8 darkdragon6 years ago

  • Keywords phpdoc has-patch added; inline-docs removed
Note: See TracTickets for help on using tickets.