Problem/Motivation
Rector inadvertently moved some def groups for the following files:
- core/modules/field/src/Hook/FieldHooks.php
- core/modules/system/src/Hook/SystemHooks.php
- core/modules/node/src/Hook/NodeHooks1.php
- core/modules/taxonomy/src/Hook/TaxonomyHooks.php
Check against 11.0 and see what those defgroups used to wrap and add the open and close in the right place.
e.g. in SystemHooks there is
/**
* @} End of "defgroup authorize".
*/
But in system.module there is:
/**
* @defgroup authorize Authorized operations
* @{
Steps to reproduce
Proposed resolution
- Update the def groups to open and close in the appropriate files
Remaining tasks
Revert last commit
Add a phpcs ignore line
Make an issue in the Coder project for the problem of 'end of @defgoup' at the end of a class.
Make an issue in Core for removing the ignore line when the Coder issue is resolved.
User interface changes
Introduced terminology
API changes
Data model changes
Release notes snippet
Comments
Comment #2
m.gaebler commentedI am starting to work on this issue during Dictus Drupal Dev Day.
Comment #3
m.gaebler commentedComment #4
avpadernoComment #6
juandhr commentedComment #8
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #9
mradcliffeI performed Novice Triage on this issue. I am leaving the Novice tag on this issue because there is a clearly defined task for resolution. The issue summary could use an update as well.
There were some test failures in the merge request, but I think those are false positives.
Comment #10
jazzsequence commentedI am looking at this issue at DrupalCon Atlanta. I am working with @heilop
Comment #11
jazzsequence commentedComment #12
jazzsequence commentedReviewed the patch and confirmed that the def groups were opened and closed appropriately and the orphaned opens and closes were removed.
Automated testing is failing, I created new merge request to rerun tests.
Comment #14
heilop commentedAs @jazzsequence mentioned, the MR request shows that the
defgroupare looking good now.After the new MR has been opened to re-run the tests, we can now confirm that the test passed. Also, the tests were run locally and passed as well.
Comment #15
mradcliffeIt looks like the issue summary has been updated. When updating the issue summary, we want to remember to remove the tag as well.
It would be nice to get another person to do a code review.
Comment #16
mmenavas commentedI verified that the functions grouped by @defgroup and @addtogroup are correctly placed and no missing opening and closing doxygen exist.
Comment #17
estebanvalerio.h commentedJust took a look to the MR at https://git.drupalcode.org/project/drupal/-/merge_requests/11653 and it looks good to me
Comment #18
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #21
dcam commentedRebased.
Comment #22
quietone commentedI reviewed the change and there is nice work here to make sure the 'end group' is in the correct place. Unfortunately, this found a bug in the sniff, Drupal.Commenting.InlineComment.DocBlock. For that, there is a few more steps here. They are in my comment on the MR and I have added that to the issue summary.
Each of the steps are suitable for the 'Novice' tag, so I am leaving the tag.
I also was to pass on that it is not necessary to open a NR to run tests. Tests can be re-run using the GitLab UI.
Comment #23
dcam commentedSorry, should have set it to NR before instead of back to RTBC.
I followed the instructions to revert my earlier changes and add the ignore directive.
The Coder module follow-up has been created at #3517312: "@} End" doc comments should be allowed at the end of classes.
I figure that the Core queue follow-up should wait until this one is committed, but I can make it now if someone wants.
Comment #24
mradcliffeDo we need to add a @todo with the issue url for the coder issue above the ignore?
I removed the Needs followup tag since @dcam created the issue.
Comment #25
quietone commentedI don't think an @todo is needed, a followup, tagged 'Coding standards', is sufficient.
Comment #26
smustgrave commentedTried my best to review this one. Based on the files mentioned in the summary believe they have been fixed, If I'm wrong I apologize now.
Comment #29
catchCommitted/pushed to 11.x and cherry-picked to 11.2.x ,thanks!
Tagging needs follow-up for the core follow-up issue to remove the phpcs:ignore, which will need to be postponed on the coder issue.
Comment #31
dcam commentedFollow-up created at #3529873: [PP-1] Remove phpcs:ignore in TaxonomyHooks.
Comment #33
nicxvan commented