[wp-trac] [WordPress Trac] #41402: Document staticvars in l10n.php (was: Needs documentation improvement)

[WordPress Trac]

#41402: Document staticvars in l10n.php
------------------------------+------------------------------
 Reporter:  nileshdudakiya94  |       Owner:
     Type:  defect (bug)      |      Status:  new
 Priority:  normal            |   Milestone:  Awaiting Review
Component:  I18N              |     Version:
 Severity:  normal            |  Resolution:
 Keywords:  has-patch         |     Focuses:  docs
------------------------------+------------------------------
Changes (by DrewAPicture):

 * component:  General => I18N


Comment:

 Hi @nileshdudakiya94, thanks for the patch.

 [attachment: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.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41402#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform