WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 5 days ago

#41402 closed defect (bug) (duplicate)

Document staticvars in l10n.php

Reported by: nileshdudakiya94 Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: I18N Keywords: needs-patch
Focuses: docs Cc:

Description

The statics variables are use in the functions but not mention in documentation of the function.

Attachments (1)

41402.patch (938 bytes) - added by nileshdudakiya94 3 years ago.

Download all attachments as: .zip

Change History (5)

#1 @nileshdudakiya94
3 years ago

  • Keywords has-patch added

#2 @DrewAPicture
3 years ago

  • Component changed from General to I18N
  • Summary changed from Needs documentation improvement to Document staticvars in l10n.php

Hi @nileshdudakiya94, thanks for the patch.

41402.patch is a good start, however, it looks you still need to add text descriptions to go along with the @staticvar notations. This is because we typically place higher value on human-consumable documentation, vs simply documenting elements for the benefits of text editors. A text description is really the human aspect of the documentation in this context :-)

Also, in the future, it would be helpful if you could supply a more specific summary when submitting trac tickets. I've gone ahead and updated the summary for you to give you some idea of what to aim for.

#3 @DrewAPicture
3 years ago

  • Keywords needs-patch added; has-patch removed

#4 @SergeyBiryukov
5 days ago

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

Thanks for the patch! This is now fixed for WordPress 5.1 in [42399] / #42800.

Note: See TracTickets for help on using tickets.