Problem/Motivation

API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Render%21...
theme path: (automatically derived) The directory path of the theme or module, so that it doesn't need to be looked up.

This bit doesn't make sense to me. The phrase 'so that it doesn't need to be looked up' is also used for the $path parameter, where it DOES make sense. Perhaps this was copied and pasted?

Also 'automatically derived' needs an explanation. What derived value will be used? Presumably, you only get that if omitted.

Steps to reproduce

Proposed resolution

New text:

The directory path of the theme or module. If not defined, it is determined during the registry process.

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#17 interdiff_14-17.txt667 bytesRatan Priya
#17 2157567-17.patch775 bytesRatan Priya
#14 2157567-14.patch776 bytessmustgrave

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes

The explanation of this issue comes from the D7 version ('path' is different in D8) but still is probably valid. I have no idea what theme path is... hopefully someone can figure it out and document it.

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

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

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.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: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should 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: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev
quietone’s picture

quietone commented
Issue summary: View changes
Status: Active » Needs review
Issue tags: +Bug Smash Initiative

Updated the link to the API because the original doesn't work anymore.

I did some research and the documentation makes sense to me but I also see it could use improvement. I'd like to avoid using derived because of it's use in the plugin system.

What about something like this?

theme path: The directory path of the theme or module. If not defined, it is determined during the registry process.

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

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

smustgrave commented
Issue tags: +Novice
StatusFileSize
new 2157567-14.patch776 bytes

Addressed #12

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Status: Needs review » Needs work

I have the tiniest nitpick

+++ b/core/lib/Drupal/Core/Render/theme.api.php
@@ -1180,8 +1180,8 @@ function hook_page_bottom(array &$page_bottom) {
+ *     it is determined during the registry process..

double period should be only one.

Ratan Priya’s picture

Ratan Priya commented
Assigned: Unassigned » Ratan Priya
Ratan Priya’s picture

Ratan Priya commented
Assigned: Ratan Priya » Unassigned
Status: Needs work » Needs review
StatusFileSize
new 2157567-17.patch775 bytes
new interdiff_14-17.txt667 bytes

@borisson_ ,

Made changes as per comment #15.

Needs review.

lucassc’s picture

lucassc
he/him
Primary language Portuguese, Brazil
Location Rio de Janeiro
commented
Assigned: Unassigned » lucassc
lucassc’s picture

lucassc
he/him
Primary language Portuguese, Brazil
Location Rio de Janeiro
commented
Assigned: lucassc » Unassigned
Issue tags: +Needs issue summary update

I applied patch in #17 for branch 9.5.x and it worked for me.

I also checked that old text

theme path: (automatically derived) The directory path of the theme or module, so that it doesn't need to be looked up.

was replaced with

theme path: The directory path of the theme or module. If not defined, it is determined during the registry process.

as suggested in #12.

Moreover, the following text with double period

it is determined during the registry process..

was replaced by

it is determined during the registry process.

as reviwed in #15.

I imagine the issue summary needs to be updated with the new text suggested in #12 to accurately reflect the change of what has been done. Tagging for Issue Summary update.

lucassc’s picture

lucassc
he/him
Primary language Portuguese, Brazil
Location Rio de Janeiro
commented
Status: Needs review » Needs work
borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Issue summary: View changes
Status: Needs work » Reviewed & tested by the community
Issue tags: -Needs issue summary update

  • xjm committed 3946bc3 on 10.1.x 
    Issue #2157567 by Ratan Priya, smustgrave, lucassc, quietone, joachim:...

  • xjm committed 912b9ab on 10.0.x 
    Issue #2157567 by Ratan Priya, smustgrave, lucassc, quietone, joachim:...

  • xjm committed 705850f on 9.5.x 
    Issue #2157567 by Ratan Priya, smustgrave, lucassc, quietone, joachim:...

  • xjm committed f419c21 on 9.4.x 
    Issue #2157567 by Ratan Priya, smustgrave, lucassc, quietone, joachim:...
xjm’s picture

xjm
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

@lucassc, it would also be helpful if you could review whether you think the proposed changes are correct. Part of peer review is not only determining that a suggestion was implemented, but also thinking about whether the suggestion is a good improvement in the first place, and whether there are further improvements that should also be made to the same documentation.

In this case, I agree that the proposed textual improvements are clear and accurate.

Committed to 10.1.x, and cherry-picked to 10.0.x, 9.5.x, and 9.4.x. Thanks!

lucassc’s picture

lucassc
he/him
Primary language Portuguese, Brazil
Location Rio de Janeiro
commented

@xjm, thanks for mentoring!

Status: Fixed » Closed (fixed)

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