Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#27129 closed defect (bug) (fixed)

Hook Docs (18): wp-includes/widgets.php

Reported by: eliorivero's profile eliorivero Owned by: drewapicture's profile DrewAPicture
Milestone: 3.9 Priority: normal
Severity: normal Version:
Component: Widgets Keywords: has-patch commit
Focuses: docs Cc:

Description

Hi, first time contributing, hope I got this right.

Added PHPDocs for class properties and public methods. Didn't touch the private ones.

Added inline docs for hooks. Didn't touch the ones labeled as temporary_hook.

Attachments (6)

widgets.php.patch (4.5 KB) - added by eliorivero 10 years ago.
Inline PHPDocs and Hook Docs.
widgets.php.2.patch (9.7 KB) - added by Nessworthy 10 years ago.
More documentation additions / changes for wp-includes/widgets.php - #27129
widgets.php.3.patch (33.6 KB) - added by Nessworthy 10 years ago.
Second pass for documentation additions / changes for wp-includes/widgets.php
widgets.php.4.patch (7.9 KB) - added by Nessworthy 10 years ago.
Third Pass. Added / Restricted documentation to hooks only for wp-includes/widgets.php
27129.diff (5.4 KB) - added by kpdesign 10 years ago.
Fourth pass
27129.2.diff (6.2 KB) - added by DrewAPicture 10 years ago.
Final pass.

Download all attachments as: .zip

Change History (19)

@eliorivero
10 years ago

Inline PHPDocs and Hook Docs.

#1 @enej
10 years ago

  • Keywords needs-patch added

Hi eliorivero

Welcome to trac, thanks for your contribution.

Here is some feedback.

  • You should make sure you have periods to at the end of sentences
  • Change the version number are 3.0.0 instead of just 3.0.
  • A description at the end of the variables would be great as well.

Checkout http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/ for more info. I am learning too, check out #26821.

Also @DrewAPicture might ask you to have 2 tickets. One for hook docs and the other for PHPDocs.

Thanks for the patch, looking forward to the next one =).

#2 @eliorivero
10 years ago

Hi enej, thank you very much for all the pointers and suggestions. I'll take them to heart and will submit a new patch.

#3 @DrewAPicture
10 years ago

  • Owner set to enej
  • Status changed from new to reviewing

#4 @kpdesign
10 years ago

  • Summary changed from Inline PHPDocs and Hook Docs: /wp-includes/widgets.php to Hook Docs (18): wp-includes/widgets.php

Hi eliorivero, thanks for the patch.

I changed the ticket summary, so this ticket is just for hook docs changes to this file.

If you could create a new ticket for the functional docs changes, and attach a patch with those changes to the new ticket, that would be great.

Thanks for contributing - look forward to the new patches. :)

#5 @enej
10 years ago

Hi eliorivero

How's it going with this ticket? Do you have any questions or need any help?

Hope all is well.

Enej

#6 @eliorivero
10 years ago

Hi enej, sorry, haven't had time for this yet. With a little luck I'll be able to do it tomorrow.

Cheers!

@Nessworthy
10 years ago

More documentation additions / changes for wp-includes/widgets.php - #27129

#7 @Nessworthy
10 years ago

Added a bit more during a lunch break. Hope this helps!
Not sure on how how to build on another user's patch, so I hope this is correct.

Last edited 10 years ago by Nessworthy (previous) (diff)

@Nessworthy
10 years ago

Second pass for documentation additions / changes for wp-includes/widgets.php

#8 @Nessworthy
10 years ago

Will need reviewing regarding some of the functions/methods and @access private.
Not all of this file is complete yet. Some functions closer to the bottom of the file still need documentation adding.

#9 @Nessworthy
10 years ago

Bit of a muck up here! Somewhere along the way I didn't realise this was primarily for hook docs. I'll see about fixing the patches and check for a new ticket today.

@Nessworthy
10 years ago

Third Pass. Added / Restricted documentation to hooks only for wp-includes/widgets.php

#10 @kpdesign
10 years ago

  • Keywords has-patch added; needs-patch removed
  • Owner changed from enej to kpdesign

@Nessworthy: Thanks for the hooks-only patch. :)

If you wish, you can create a new ticket for your functional docs changes, and we'll review those on the new ticket.

@kpdesign
10 years ago

Fourth pass

#11 @kpdesign
10 years ago

  • Owner changed from kpdesign to DrewAPicture

@DrewAPicture
10 years ago

Final pass.

#12 @DrewAPicture
10 years ago

  • Keywords commit added
  • Milestone changed from Awaiting Review to 3.9

#13 @DrewAPicture
10 years ago

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

Fixed in [27870].

Props eliorivero and Nessworthy for the initial patches. Props kpdesign.

Note: See TracTickets for help on using tickets.