WordPress.org

Make WordPress Core

Opened 2 years ago

Last modified 2 years ago

#41402 new defect (bug)

Document staticvars in l10n.php

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

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 2 years ago.

Download all attachments as: .zip

Change History (4)

#1 @nileshdudakiya94
2 years ago

  • Keywords has-patch added

#2 @DrewAPicture
2 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
2 years ago

  • Keywords needs-patch added; has-patch removed
Note: See TracTickets for help on using tickets.