In the templates, the documentation says the following:

 *  - $language: The language object for this message.

This is incorrect, as $language is a langcode (ex en, ja), and not a language object (which would be an object containing all the information for the given language).

I'll attach a patch to the first comment.

CommentFileSizeAuthor
#4 htmlmail-language_documentation_fix-2633056-4.patch2.39 KBsalvis
#2 htmlmail-language_documentation_fix-2633056-1-7.patch1.59 KBjaypan

Comments

Jaypan created an issue. See original summary.

jaypan’s picture

jaypan
Location Victoria, BC
commented
StatusFileSize
new htmlmail-language_documentation_fix-2633056-1-7.patch1.59 KB

Here's a patch that fixes the documentation.

jaypan’s picture

jaypan
Location Victoria, BC
commented
Status: Active » Needs review
salvis’s picture

salvis
he/his
commented
StatusFileSize
new htmlmail-language_documentation_fix-2633056-4.patch2.39 KB

Thank you for the report and patch, Jaypan!

We have additional occurences of the The language object for this message. string in htmlmail.admin.inc and htmlmail.markdown.

Is there a reason for not fixing those?

Status: Needs review » Needs work

The last submitted patch, 4: htmlmail-language_documentation_fix-2633056-4.patch, failed testing.

salvis’s picture

salvis
he/his
commented
Version: 7.x-2.65 » 7.x-2.x-dev
Status: Needs work » Needs review
jaypan’s picture

jaypan
Location Victoria, BC
commented

Is there a reason for not fixing those?

I probably just didn't notice them. It wasn't a conscious decision.

  • salvis committed c8f1291 on 7.x-2.x 
    Issue #2633056 by Jaypan, salvis: Fix documentation for $language.
salvis’s picture

salvis
he/his
commented
Status: Needs review » Fixed

Ok, thanks!

jaypan’s picture

jaypan
Location Victoria, BC
commented

I just went back and checked - I actually did make those changes, I just forgot to add them to my commit, so they didn't end up in the diff! Sorry about that, and I'm glad you noticed.

salvis’s picture

salvis
he/his
commented

No problem. :-)

BTW, others are trying to remove those templates in #1170576-9: Improve documentation on the order of precedence of theme suggestions. because you cannot disable them except for deleting them from the module directory (= hacking contrib). What's your take on that?

jaypan’s picture

jaypan
Location Victoria, BC
commented

I had to remove them myself, for the exact reason you stated. But I needed the template so I could copy it, so removing it altogether wouldn't be ideal.

I think there is probably a solution to this. I'll take a look at the code over the next couple of days and see if I can find one.

Status: Fixed » Closed (fixed)

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