Postponed
Project:
Drupal core
Version:
main
Component:
other
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Anonymous (not verified)
Created:
12 Mar 2017 at 17:59 UTC
Updated:
18 Dec 2020 at 01:07 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
Anonymous (not verified) commentedvaplas created an issue. See original summary.
Comment #2
Anonymous (not verified) commentedComment #3
opensense commentedPatch applies cleanly and the changes work well.
Comment #4
opensense commentedComment #5
opensense commentedComment #6
alexpottThis suggests that
update_language_list()should just be removed. Instead of adding these use statements here - can we file a separate issue to remove this method - it is obviously not working. It'd error immediately. It was added without usage in #1754246: Languages should be configuration entities.The rest of the patch is a mixture of different types of coding standards for example:
@throws, @param and @return. These should be addressed by the coding standards project. One at a time and by enabling coding standards rules in phpcs.xml.dist so that we don't introduce regressions.
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.
Comment #7
alexpott@xjm pointed out that I closed this prematurely.
update_language_list()This is another reason why doing this via coding standards is good. This file intentionally follows Synfony's coding standards where this @return is valid.
Comment #8
alexpott@vidhatanand thank you for reviewing this issue!
The automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. It is also not sufficient criteria for the issue to be marked "Reviewed and Tested by the Community".
What we do need people to review is whether the issue has a correct scope, whether it passes the core gates, whether the solution completely fixes the problem without introducing other problems, and whether it's the best solution we can come up with. See the patch review guide for more information.
When you do post a review, be sure to describe what you reviewed and how. This helps other reviewers understand why you considered the issue RTBC (and is considered for issue credit).
Comment #9
Anonymous (not verified) commented@alexpott, many thanks for such a detailed explanation!
Done. #2860277: update_language_list() should be removed
I am also very grateful to @xjm for taking care of the bit right part of the patch, and to @vidhatanand for interest in this idea!
Comment #10
ashishdalviComment #11
pk188 commentedRe rolled because last one failed to apply.
Comment #13
pk188 commentedComment #14
vegantriathleteComment #15
mile23This seems like a lot of different types of cleanups. I think they're all probably decent changes. But we're about to have 8.4-alpha, so some might be allowed changes and some might not by the time this gets reviewed. See the list of allowed changes here: https://www.drupal.org/core/d8-allowed-changes#alpha
Check out the links from #8 and maybe split this up into different issues depending on whether you think they'd be allowed in alpha.
Comment #17
michaellenahan commentedComment #18
ivan berezhnov commentedComment #19
arunkumarkComment #20
arunkumarkComment #27
quietone commentedPatch 12 contained changes for 73 files and this reroll has changes for 43. Nice to know that many of these fixes has already happened.
The patch remains a mixture of fixing different coding standards and no tests are being run on it. #7 says this should be about the *.api.php files and I'll do a patch for that next.
Comment #28
quietone commentedforgot to upload the patch. This is the reroll mentioned above.
Comment #29
quietone commentedThis patch is just the changes for *.api.php files plus the patch from #3089634: missing initial backslash on parameter interface typehints in entity.api.php.
Changing to NR to run tests.
Comment #31
quietone commentedThere is 3089634#15 from xjm in #3089634: missing initial backslash on parameter interface typehints in entity.api.php that is worth duplicating here.
This issue now covers all *.api.php file.
Closed #3089634: missing initial backslash on parameter interface typehints in entity.api.php as a duplicate and added credit here.
Comment #32
quietone commented#7.3 Add the follow made as a related issue #2860277: update_language_list() should be removed
Comment #33
quietone commentedComment #34
quietone commented