Closed (fixed)
Project:
Drupal core
Version:
8.6.x-dev
Component:
render system
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
23 Jan 2018 at 19:18 UTC
Updated:
17 May 2018 at 16:59 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
MerryHamster commentedThe beginning of the division of the big patch))
One moment is not clear for me: where (I mean issue) do we need to add changes to descriptions of functions?
Here or to another issue?
Comment #3
MerryHamster commentedComment #4
msankhala commented@MerryHamster Thanks for the patch.
\Drupal\Core\Render\RendererInterface::render()should be on the same line if line length does not exceed 80 characters. This same applies to all places.I think the changes in function description should be done in #2938969: Replace drupal_render() in docblock and comments outside of @param, @return, @link, @see and outside of @code - @endcode.
I think there are few more places with @param, @return, @see, @link which mention drupal_render. I have updated the issue summary to help you with this.
Comment #5
MerryHamster commentedfixed #4 remark
Comment #6
MerryHamster commentedComment #7
MerryHamster commentedoh, I found some more plases with 'drupal_render' with @param, @return, @see, @link
thanks @msankhala for tip with grep
Comment #8
msankhala commented@MerryHamster its almost there.
line length in docblock should not be more than 80 characters.
I think you deleted the first line by mistake.
Comment #9
surbz commentedThanks @MerryHamster for this great patch, I was reading through and found that #7 covers most of it also the feedback mentioned in #8 was real quick and I have addressed these changes here.
Thanks @msankhala for reviewing this.
2938970-9.patch now contains changes requested in #8 and is ready for review.
Comment #10
surbz commentedComment #11
msankhala commentedThanks, @surbz for the updated patch. One small fix though. It has one trailing white space.
Comment #12
surbz commentedAaah! Thanks for noticing that.
Here is the updated one \m/
Comment #13
surbz commentedComment #14
andypost@surbz please add interdiff of changes you made, ref https://www.drupal.org/documentation/git/interdiff
Comment #15
surbz commentedAttaching the interdiff .
Comment #16
msankhala commentedPatch #12 applies cleanly and interdiff-7-12.txt looks fine. This patch removed all the
drupal_renderinside@param, @return, @see, @link, etc. After applying this patchdrupal_renderare only left inside one line summaries or outside of@param, @return, @see, @linkthat should be fixed in #2938969: Replace drupal_render() in docblock and comments outside of @param, @return, @link, @see and outside of @code - @endcodeAfter applying the patch I verified this with this command on mac.
grep -rn -B 5 -A 5 drupal_render core | grep -E '@link|@param|@return|@see' | awk -F'-' -v colon=':' '{print $1 colon $2}' | xargs sublThis command will open all the files in sublime where
drupal_renderis found. Then you can verify thatdrupal_renderis only left outside of@param, @return, @see, @link. This command assumes that you have sublime added in your shellPATH. Otherwise runln -s /Applications/Sublime\ Text.app/Contents/SharedSupport/bin/subl /usr/local/bin/sublto add sublime in your path.Comment #26
alexpottAdding credit from the parent issue.
Comment #27
alexpottCrediting @msankhala for reviews on this issue.
Comment #28
alexpottBackported to 8.5.x as this is a docs patch.
Committed and pushed 3bfc5a384b to 8.6.x and e8157ca90a to 8.5.x. Thanks!