Closed (duplicate)
Project:
Drupal core
Version:
8.6.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
9 Jun 2018 at 10:07 UTC
Updated:
11 Jun 2018 at 17:56 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
loopduplicate commentedComment #3
sudheeshps commentedApplied patch from #2 and was successful
"@param \Drupal" has got changed in the documentation blocks for 3 files listed below
modules/comment/comment.module
modules/help/help.api.php
shortcut/shortcut.module
Comment #4
nerdsteinI also code reviewed the patch and confirm the proper formatting was applied.
Comment #5
loopduplicate commentedThanks for reviewing :) @sudheeshps, next time you'll need to leave a little more description about what you tested. Your comment suggests that you duplicated the efforts of the testbot. I'm sure you manually reviewed the patch too, but it's always good to say so :) Cheers, Jeff
Comment #6
loopduplicate commentedComment #7
sudheeshps commented@loopduplicate thanks for the suggestions. Will follow the same from next time
Comment #8
loopduplicate commented@sudheeshps Welcome :) Cheers
Comment #9
alexpottThank you for your work on cleaning up Drupal core's code style!
In order to fix core coding standards in a maintainable way, all our coding standards issues should be done on a per-rule basis across all of core, rather than fixing standards in individual modules or files. We should also separate fixes where we need to write new documentation from fixes where we need to correct existing standards. This all should be done as part of #2571965: [meta] Fix PHP coding standards in core, stage 1. A good place to start is the child issues of #2572645: [Meta] Fix 'Drupal.Commenting.FunctionComment' coding standard.
For background information on why we usually will not commit coding standards fixes that aren't scoped in that way, see the core issue scope guidelines, especially the note about coding standards cleanups. That document also includes numerous suggestions for scoping issues including documentation coding standards cleanups.
Contributing to the overall plan above will help ensure that your fixes for core's coding standards remain in core the long term.
Taking such an apporach would allow us to not make the same mistake in the future and identify all the current errors in the code base. For example there's:
in core/lib/Drupal/Core/EventSubscriber/RequestCloseSubscriber.php
Comment #10
alexpottI think this is a duplicate of #2723621: Fix Drupal.Commenting.FunctionComment.IncorrectTypeHint and Drupal.Commenting.FunctionComment.InvalidTypeHint