WordPress.org
Get WordPress

Make WordPress Core

Opened 2 years ago

Closed 23 months ago

#58606 closed defect (bug) (duplicate)

Twenty Thirteen: Improve various globals documentation

Reported by: upadalavipul's profile upadalavipul Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Bundled Theme Keywords: has-patch
Focuses: docs Cc:

Description

I have reviewed the code and found some of the files need to be improved comment code. Please check the below files.

File Name:

  1. twentythirteen/functions.php
  2. twentythirteen/inc/back-compat.php

Attachments (2)

58606.patch​ (1.6 KB) - added by upadalavipul 2 years ago.
58606.2.patch​ (2.2 KB) - added by shailu25 2 years ago.
Patch Added

Download all attachments as: .zip

Change History (7)

@upadalavipul
2 years ago

#1 @sabernhardt
2 years ago

  • Component changed from General to Bundled Theme
  • Keywords has-patch changes-requested added
  • Summary changed from Docs: Improve various globals documentation, as per docblock standards on twenty thirteen theme. to Twenty Thirteen: Improve various globals documentation
  • Version trunk deleted

Please add the global documentation after the since and deprecated notes.
​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#1-functions-class-methods

@shailu25
2 years ago

Patch Added

#2 @shailu25
2 years ago

@sabernhardt

I have Updated Patch as per reference

#3 @shailu25
2 years ago

#59140 was marked as a duplicate.

#4 @huzaifaalmesbah
2 years ago

Thank you for reporting @upadalavipul, and also thanks for adding patch @shailu25

#5 @sabernhardt
23 months ago

  • Keywords changes-requested removed
  • Milestone Awaiting Review deleted
  • Resolution set to duplicate
  • Status changed from new to closed

Thanks for updating the patch. The resource hints function did not need a line between since and deprecated, and some of the empty lines had a space after the asterisk (*).

I combined this with other global documentation for themes on #58715, so let's continue the discussion on that ticket.

Note: See TracTickets for help on using tickets.