WordPress.org

Make WordPress Core

Opened 8 years ago

Closed 8 years ago

#5233 closed enhancement (fixed)

update.php documentation

Reported by: darkdragon Owned by: westi
Milestone: 2.5 Priority: normal
Severity: normal Version: 2.5
Component: Optimization Keywords: phpdoc documentation has-patch
Focuses: Cc:

Description

I went ahead and documented update.php with the lone function. It was easy and should at least help move any additional functions forward for additional phpdoc documentation.

Attachments (2)

update.phpdoc.diff (1.2 KB) - added by darkdragon 8 years ago.
update.php documentation which adds phpdoc
update.phpdoc.2.diff (1.0 KB) - added by darkdragon 8 years ago.
Fixes from Westi suggestion

Download all attachments as: .zip

Change History (7)

@darkdragon8 years ago

update.php documentation which adds phpdoc

comment:1 @westi8 years ago

I think that the documentation in the code should describe the purpose of the function and it's arguments and returns to enable it to be called.

Any extra information like how to disable a feature should not be in the documentation.

That kind of information is better stored in the codex.

comment:2 @darkdragon8 years ago

Thanks. I'll remove it. The plugin is available in plain sight so yeah, it would be unbiased to remove that text. I'll clean up the rest of it and submit a new patch.

@darkdragon8 years ago

Fixes from Westi suggestion

comment:3 @darkdragon8 years ago

Finished with Westi suggestion and added patch.

comment:4 @westi8 years ago

  • Owner changed from anonymous to westi
  • Status changed from new to assigned

comment:5 @westi8 years ago

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

(In [6297]) Add documentation for wp_version_check(). Fixes #5233 props darkdragon.

Note: See TracTickets for help on using tickets.