Ticket #5233 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

update.php documentation

Reported by: darkdragon Owned by: westi
Priority: normal Milestone: 2.5
Component: Optimization Version: 2.5
Severity: normal Keywords: phpdoc documentation has-patch
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

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

Change History

update.php documentation which adds phpdoc

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.

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.

Fixes from Westi suggestion

Finished with Westi suggestion and added patch.

  • Owner changed from anonymous to westi
  • Status changed from new to assigned
  • Status changed from assigned to closed
  • Resolution set to fixed

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

Note: See TracTickets for help on using tickets.