[wp-trac] [WordPress Trac] #16750: Improve inline docs for l10n functions

[WordPress Trac]

#16750: Improve inline docs for l10n functions
------------------------------+-----------------------------
 Reporter:  CharlesClarkson   |       Owner:  SergeyBiryukov
     Type:  enhancement       |      Status:  closed
 Priority:  normal            |   Milestone:  3.7
Component:  Inline Docs       |     Version:  3.1
 Severity:  trivial           |  Resolution:  fixed
 Keywords:  has-patch commit  |
------------------------------+-----------------------------

Comment (by ericlewis):

 Replying to [comment:14 SergeyBiryukov]:
 > s/domain/text domain/ seems fine.
 >
 > For the longer string, I'd suggest adding "Text domain" in front of it,
 rather than replacing it. There should still be some short description,
 and the "unique identifier" serves that well.

 Here I thought giving the entire name for the unique identifier (Text
 domain) is more helpful instead of telling that is a unique identifier.
 There are a lot of unique identifiers that get tossed around WP core (Post
 ID, taxonomy name, etc.), and developers can be expected to look up the
 l18n API to understand what a text domain is, and that a text domain
 should be a unique identifier, which is why I left it out. It's a grey
 area between where we expect developers to seek more complete
 documentation and brevity.

 Please tell me if I'm getting too pedantic :)

--
Ticket URL: <http://core.trac.wordpress.org/ticket/16750#comment:15>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software