Document return value in \Drupal\locale\LocaleTranslation::getStringTranslation

Did some debugging and now I know why that confusing comparison is there, and it's not buggy. Added a comment explaining why.

     $translation = $this->translations[$langcode][$context]->get($string);
+    // If translation is TRUE means that no translation exists, but the source
+    // string was successfully stored in the persistent cache (in this
+    // translator, that means a new entry on the 'locales_source' table).
     return $translation === TRUE ? FALSE : $translation;

Debugged again and now makes more sense (I wasn't technically correct)

    $translation = $this->translations[$langcode][$context]->get($string);
    // If translation is TRUE means that no translation exists, but that string
    // needs to be stored in the persistent cache for performance reasons (so
    // e.g. we don't have hundreds of queries to locale tables on each request).
    // That cache is persisted when the request ends and the lookup service is
    // destructed.
    return $translation === TRUE ? FALSE : $translation;

Nit picky

But believe core is trying to avoid the use of e.g. can you just change that to example.

The rest looks good.

Made changes as per comment #15.

Look fine now.

#16 worked fine for me.

There's a grammar error now.

Updated patch #16 by addressing #20, please review it.

Thanks!

Comment change makes sense. Proposed solution kinda mentions it but borderline. Think should be fine though.

This is better!

Thanks!

The last submitted patch, 21: 2188715-21.patch, failed testing. View results →

Unrelated test failure.

Suggesting a title that reflects the change.

Docs definitely help with the confusing return value.

Committed/pushed to 10.1.x, cherry-picked to 10.0.x and 9.5.x, thanks!

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