t() documentation cleanup

dww - December 23, 2008 - 23:53
Project:Drupal
Version:7.x-dev
Component:documentation
Category:task
Priority:normal
Assigned:dww
Status:closed
Description

After an illuminating thread on the translators' list, we decided it'd be nice to backport some of the PHPDoc fixes from the t() function in D6 into D5. The docs were nicely fleshed out, even though the function itself changed very little. I'm working on a patch now, stay tuned.

#1

dww - December 24, 2008 - 00:13
Status:active» needs review

This is the entire D6 version of the PHPdoc comment, except I stripped out the D6-only changes:

- url() args in an example.
- the D6-only $langcode argument.

I also fixed a few lingering formatting problems from the D6 and HEAD version, included in the D5 patch, and attached here as separate patches for D6 and HEAD (the D6 patch applies to HEAD with fuzz, but it was easy to generate a clean patch). I don't think the usual "rule" about committing in HEAD and backporting applies to doc formatting patches, and the most important part is getting the content into the D5 version, so I'm leaving the version of this as 5.x-dev.

Thanks,
-Derek

AttachmentSizeStatusTest resultOperations
350708_t_docs_formatting.1.d7.patch3.02 KBIdlePassed: 8010 passes, 0 fails, 0 exceptionsView details
350708_t_docs_formatting.1.d6.patch3.02 KBIgnoredNoneNone
350708_t_docs_backport.1.d5.patch6.82 KBIgnoredNoneNone

#2

drumm - December 25, 2008 - 20:38
Title:Backport PHPDoc improvements on t() from D6» t() documentation cleanup
Version:5.x-dev» 7.x-dev

Committed to 5.x.

#3

drumm - December 25, 2008 - 20:38
Status:needs review» reviewed & tested by the community

#4

Dries - December 26, 2008 - 10:43
Status:reviewed & tested by the community» fixed

Committed to DRUPAL-6 and CVS HEAD. Thanks dww!

#5

dww - December 26, 2008 - 11:35

No problem, thanks Drumm and Dries. Happy holidays! :)

#6

System Message - January 9, 2009 - 11:40
Status:fixed» closed

Automatically closed -- issue fixed for two weeks with no activity.

 
 

Drupal is a registered trademark of Dries Buytaert.