Make WordPress Core

Opened 10 months ago

Closed 4 months ago

Last modified 4 months ago

#59101 closed defect (bug) (duplicate)

Twenty Fourteen: Improve various globals documentation, as per docblock standards.

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

Description

I have reviewed the Twenty Fourteen theme file code and found some of the files need to be improved with function commenting code. Please check the below files list.

File's

  1. wp-content/themes/twentyfourteen/functions.php
  2. wp-content/themes/twentyfourteen/inc/back-compat.php
  3. wp-content/themes/twentyfourteen/inc/customizer.php
  4. wp-content/themes/twentyfourteen/inc/widgets.php

Attachments (5)

59101.patch (3.5 KB) - added by upadalavipul 10 months ago.
59101.2.patch (3.5 KB) - added by rajinsharwar 10 months ago.
Adding a lne between the global and since
59101.3.patch (3.5 KB) - added by upadalavipul 10 months ago.
updated space and line
59101-twentytwenty.patch (448 bytes) - added by viralsampat 10 months ago.
I have checked another theme and founds few file. Here, I have added its patch.
59101-twentyfifteen.patch (2.8 KB) - added by viralsampat 10 months ago.
I have checked another theme and founds few file. Here, I have added its patch.

Download all attachments as: .zip

Change History (8)

#1 @audrasjb
10 months ago

  • Keywords changes-requested has-patch added
  • Owner set to audrasjb
  • Status changed from new to reviewing

Hello and thanks for the patch proposal,

There is a small indentation issue in twentyfourteen/inc/widgets.php: you should have an empty line beetween @since and $global lines, and then the indentation of the @global line should be different :)

@rajinsharwar
10 months ago

Adding a lne between the global and since

#2 @audrasjb
10 months ago

Thanks for the new patch but your forgot to fix the related indentation issue (too many spaces before and after the name of the variable).

@upadalavipul
10 months ago

updated space and line

@viralsampat
10 months ago

I have checked another theme and founds few file. Here, I have added its patch.

@viralsampat
10 months ago

I have checked another theme and founds few file. Here, I have added its patch.

#3 @sabernhardt
4 months ago

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

Thanks for the patches. The $content_width variable only needed one space before and after it in widgets.php, but the same function also uses $more.

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

Last edited 4 months ago by sabernhardt (previous) (diff)
Note: See TracTickets for help on using tickets.