Problem/Motivation
While working on the t() docs in #2570431: Document that certain (non-"href") attribute values in t() and SafeMarkup::format() are not supported and may be insecure,
noticed this:
* The t() function serves two purposes. First, at run-time it translates
* user-visible text into the appropriate language. Second, various mechanisms
* that figure out what text needs to be translated work off t() -- the text
* inside t() calls is added to the database of strings to be translated.
* These strings are expected to be in English, so the first argument should
* always be in English. To enable a fully-translatable site, it is important
* that all human-readable text that will be displayed on the site or sent to
* a user is passed through the t() function, or a related function. See the
* @link https://www.drupal.org/node/322729 Localization API @endlink pages for
* more information, including recommendations on how to break up or not
* break up strings for translation.
in bootstrap.inc
The part:
"To enable a fully-translatable site"
might be misleading.
Proposed resolution
Change to
"To allow the site to be localized"
or
....
Remaining tasks
Task | Novice task? | Contributor instructions | Complete? |
---|---|---|---|
Update the patch to incorporate feedback from reviews (include an interdiff) | Instructions | ||
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards | Instructions |
User interface changes
None.
API changes
None.
Data model changes
None.
Comment | File | Size | Author |
---|---|---|---|
#20 | 2576431.17.patch | 1.1 KB | YesCT |
#17 | interdiff.2576431.3.17.txt | 1.1 KB | YesCT |
#17 | 2576431.17.patch | 1.1 KB | YesCT |
| |||
#12 | interdiff-2576431-3-12.txt | 1.42 KB | joyceg |
#12 | clarification-2576431-12-D8.patch | 2.43 KB | joyceg |
|
Comments
Comment #2
joyceg CreditAttribution: joyceg commentedComment #3
joyceg CreditAttribution: joyceg commentedComment #4
joyceg CreditAttribution: joyceg commentedComment #5
YesCT CreditAttribution: YesCT commented@joyceg thanks for making the patch.
The wording looks good to me.
since that shortened the line, that line and the next lines should be re-wrapped to be as close to 80 characters as possible. (dont fix unrelated things, just the lines we have to change)
https://www.drupal.org/node/1354#drupal
"Lines containing comments (including docblocks) must wrap as close to 80 characters as possible without going over,..."
Comment #6
joyceg CreditAttribution: joyceg commentedComment #7
joyceg CreditAttribution: joyceg commentedI am adding the interdiff and the patch here.
Comment #8
joyceg CreditAttribution: joyceg commentedComment #9
YesCT CreditAttribution: YesCT commentedI think these lines need to be wrapped to 80 chars also.
---------
and the patch file should not be in the patch file... :)
adding .patch to your gitignore is a good idea.
here is a sample of mine if that helps https://gist.github.com/YesCT/d968f8209fde43c52090
Comment #11
joyceg CreditAttribution: joyceg commentedOkay.I will work on it.
Comment #12
joyceg CreditAttribution: joyceg commentedComment #13
joyceg CreditAttribution: joyceg commentedComment #16
YesCT CreditAttribution: YesCT commentedso I looked up @link:
https://www.drupal.org/node/1354#link
The entire @link ... @endlink must be on the same line
Comment #17
YesCT CreditAttribution: YesCT commenteddoing that. interdiff to patch in 3.
reviewing with
git diff --color-words
will probably be helpful.
Comment #20
YesCT CreditAttribution: YesCT commentedha! now the actual patch.
Comment #21
j2r CreditAttribution: j2r commentedApplied the patch and docs updated as required.
Previous text - To enable a fully-translatable site,
Updated text - To allow the site to be localized,
Comment #22
dani3lr0se CreditAttribution: dani3lr0se as a volunteer commentedThe new wording looks good. Nice job.
Comment #23
alexpottCommitted 10f1025 and pushed to 8.0.x. Thanks!