The correct doxygen is "Returns the translatable object referring to the original language." this is very strange and doesn't mesh with the doxygen of say getTranslation() which doesn't mention any references. Suggested simple patch attached.

CommentFileSizeAuthor
#12 3065574_4.patch715 bytesquietone
#4 3065574_4.patch715 bytesghost of drupal past
#2 3065574.patch743 bytesghost of drupal past

Comments

Charlie ChX Negyesi created an issue. See original summary.

ghost of drupal past’s picture

ghost of drupal past
he/him
commented
StatusFileSize
new 3065574.patch743 bytes
amateescu’s picture

amateescu commented
Status: Needs review » Needs work 
  1. +++ b/core/lib/Drupal/Core/TypedData/TranslatableInterface.php
@@ -78,10 +78,10 @@ public function getTranslationLanguages($include_default = TRUE);
+   * Returns the translatable object in the original language.

    How about "Returns the translatable object in the original language it was created."? 

  2. +++ b/core/lib/Drupal/Core/TypedData/TranslatableInterface.php
@@ -78,10 +78,10 @@ public function getTranslationLanguages($include_default = TRUE);
+   *   The untranslated entity.

    We shouldn't mention entities in the typed data documentation :)

    Also, this line is not really needed because it's only repeating the first doxygen sentence, and since @return $this doesn't require any additional info, I think it would be better to just remove it.

ghost of drupal past’s picture

ghost of drupal past
he/him
commented
Status: Needs work » Needs review
StatusFileSize
new 3065574_4.patch715 bytes

Let's try this one.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +Bug Smash Initiative

💄This came up as today's Bug Smash daily triage target

Code looks good to me.

Are we sure that bug is the right category? Is this a documentation task instead?

Either way RTBC

dww’s picture

dww
we/he/they
commented
Category: Bug report » Task

Agreed this is RTBC, and that it's not a bug. Moving to a task. Still an important improvement.

Thanks everyone!
-Derek

quietone’s picture

quietone commented
StatusFileSize
new 3065574_4.patch715 bytes

Re uploading patch so it is tested with 9.4.x

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 12: 3065574_4.patch, failed testing. View results

dww’s picture

dww
we/he/they
commented
Status: Needs work » Reviewed & tested by the community

Looks like a random fail, requeued.

  • catch committed 9633325 on 10.0.x 
    Issue #3065574 by Charlie ChX Negyesi, quietone, amateescu:...

  • catch committed a9e0250 on 9.3.x 
    Issue #3065574 by Charlie ChX Negyesi, quietone, amateescu:...
  • catch committed f7385ac on 9.4.x
    Issue #3065574 by Charlie ChX Negyesi, quietone, amateescu:...
catch’s picture

catch
he/him
Primary language English
commented
Version: 9.4.x-dev » 9.3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 10.0.x, cherry-picked to 9.4.x and 9.3.x, thanks!

Status: Fixed » Closed (fixed)

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