WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

#54198 closed enhancement (invalid)

Missing short description in doc comment

Reported by: yagniksangani's profile yagniksangani Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Bootstrap/Load Keywords: has-patch
Focuses: docs, coding-standards Cc:

Description


Attachments (3)

missing_desc.png​ (18.6 KB) - added by yagniksangani 3 years ago.
54198.diff​ (446 bytes) - added by yagniksangani 3 years ago.
Diff File
54198.patch​ (715 bytes) - added by aezazshekh 3 years ago.
added short description in doc comment

Download all attachments as: .zip

Change History (6)

@yagniksangani
3 years ago

@yagniksangani
3 years ago

Diff File

#1 @yagniksangani
3 years ago

  • Type changed from defect (bug) to enhancement

#2 @SergeyBiryukov
3 years ago

  • Component changed from General to Bootstrap/Load
  • Focuses docs added
  • Keywords has-patch added; needs-patch removed

@aezazshekh
3 years ago

added short description in doc comment

#3 @SergeyBiryukov
2 years ago

  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from new to closed

Hi there, thanks for the patch! Sorry it took a while for someone to get back to you.

I believe this fragment is correct as is, it only and specifically describes the globals. Since it's not a class method or a function DocBlock, it does not need a short description as per the ​documentation standards.

It is also worth noting that similar fragments also exist in other files, so if the standards are reconsidered at some point, this should be addressed in a consistent way and not just in a single file.

Note: See TracTickets for help on using tickets.