Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.Problem/Motivation
A follow up to #2015307: \Drupal\Core\Render\RendererInterface::render() docs do not mention most of the base # attributes, adding default attributes to elements or how rendering works to change the indentation of the docs of \Drupal\Core\Render\RendererInterface::render() to comply with the Drupal API documentation and comment standards. See #34.
I think Making lists in documentation is the relevant section.
Steps to reproduce
Proposed resolution
Fix the indentation.
Remaining tasks
Make a patch
Review
Commit
User interface changes
N/A
API changes
N/A
Data model changes
N/A
Release notes snippet
N/A
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | drupal-indentation-doc-block-render-interface-3270081-2.patch | 24.95 KB | franck_lorancy |
Comments
Comment #2
franck_lorancy commentedComment #3
cilefen commentedComment #4
libbna commentedIndentation is good. But when I checked for Drupal coding standards found these three errors.
Comment #5
franck_lorancy commentedThanks Libbna Mathew for your return. I have added missing array type hint.
Comment #6
franck_lorancy commentedComment #7
libbna commentedReviewed #5 patch and found no errors.
Comment #8
star-szrThanks for the work here, folks! Those additional changes (type hinting) are out of scope for a documentation ticket.
See: https://www.drupal.org/docs/develop/issues/issue-procedures-and-etiquett...
Comment #9
libbna commented@Cottser hey, can you explain a little bit what do you mean by
"out of scope for a documentation ticket"? Thanks.Comment #10
franck_lorancy commentedThank you Cottser for your comment. Is Patch #2 can resolve this issue? Should I open a merge request?
Comment #11
star-szr@Libbna Mathew - Changing type hints in nearby code is not within the scope of this ticket since this is only meant to update documentation (it's under the 'documentation' component). Please see the link from my previous comment, there is a lot of relevant information on that page about issue scoping.
The patch in #2 looks good! @franck_lorancy there should be no need to open a merge request but feel free to.
Comment #13
libbna commentedOK. Thank you for the info. @Cottser.
Comment #18
alexpottCreditting @quietone for creating the issue and @Cottser for issue management.
Committed and pushed e16ec17906 to 10.0.x and 5859d6d5d9 to 9.5.x and 5c791bc22b to 9.4.x and 1d657bd0ce to 9.3.x. Thanks!
Backported to 9.3.x since this documentation.
@Libbna Thank you for looking into this issue.
Posting screenshots of your codebase or command-line interface does not advance the issue, since the automated testing infrastructure tells us whether the change set still applies correctly.
So, I've removed the issue credit for that screenshot. In the future, you can get credit for issues by reading the issue to understand its purpose, and posting your review or testing of that purpose. Thank you!
See the issue credit guidelines for more information.