This is a part of the attempt to fix #2572645: [Meta] Fix 'Drupal.Commenting.FunctionComment' coding standard. This issue is created to tackle issues related to @see references

The following sub-sniffs are being fixed in this issue

Drupal.Commenting.FunctionComment.SeeAdditionalText
Drupal.Commenting.FunctionComment.SeePunctuation

CommentFileSizeAuthor
#14 drupal-coding-standards-function-comment-see-references-issues-2716661-14.patch37.12 KBanoopjohn
#14 interdiff-2716661-11-14.patch23.36 KBanoopjohn
#11 drupal-coding-standards-function-comment-see-references-issues-2716661-11.patch35.21 KBanoopjohn
#6 drupal-coding-standards-function-comment-see-references-issues-2716661-6.patch35.28 KBanoopjohn
#2 drupal-coding-standards-function-comment-see-references-issues-2716661-2.patch35.28 KBanoopjohn
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

anoopjohn created an issue. See original summary.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
FileSize
drupal-coding-standards-function-comment-see-references-issues-2716661-2.patch35.28 KB

Attached please find the patch with the fixes to the sub-sniffs and changes to phpcs.xml.dist

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Status: Active » Needs review

Status: Needs review » Needs work

The last submitted patch, 2: drupal-coding-standards-function-comment-see-references-issues-2716661-2.patch, failed testing.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Assigned: anoopjohn » Unassigned
Status: Needs work » Needs review

Not sure why this fails testing. The patch only changes comments. Changing status back to Needs Review

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
FileSize
drupal-coding-standards-function-comment-see-references-issues-2716661-6.patch35.28 KB

Head has moved on and the changes in phpcs.xml.dist is preventing the patch from being applied.

Also the patch conflicts with #2708185: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to spacing and styling

I have however re-rolled the patch such that it cleanly applies on the latest head after the patch in #2708185: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to spacing and styling is applied. I hope this protocol is correct. If I am doing something wrong please let me know.

interdiff is returning blank and hence not attaching it.

Status: Needs review » Needs work

The last submitted patch, 6: drupal-coding-standards-function-comment-see-references-issues-2716661-6.patch, failed testing.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Status: Needs work » Needs review

I think the failure is alright as this patch is expected to go after #2708185: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to spacing and styling. Changing back to Needs Review

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Needs review » Needs work
Issue tags: +Needs reroll

Needs reroll

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented

I am able to apply the patch cleanly on 8.2.x. Can you please let me know if there is anything else that has to be done?

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
FileSize
drupal-coding-standards-function-comment-see-references-issues-2716661-11.patch35.21 KB

Pulled again and I see changes in phpcs.xml that prevents the patch to be cleanly applied. Re-rolled and attached again.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Status: Needs work » Needs review
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Needs review » Needs work 
  1. +++ b/core/includes/install.inc
@@ -363,7 +363,7 @@ function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
- *   @see token_name().
+ *   @see token_name()

@@ -387,7 +387,7 @@ function _drupal_rewrite_settings_is_simple($type, $value) {
- *   @see token_name().
+ *   @see token_name()

+++ b/core/lib/Drupal/Core/Template/TwigExtension.php
@@ -206,7 +206,7 @@ public function getName() {
-   *   @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute().
+   *   @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()

+++ b/core/modules/locale/src/LocaleConfigManager.php
@@ -204,7 +204,7 @@ protected function getTranslatableData(TypedDataInterface $element) {
-   *   @see self::getTranslatableData().
+   *   @see self::getTranslatableData()

    These ones are interesting. I think they need to be moved to be after the @return. I don't think @see's can be part of a param doc block. 

  2. +++ b/core/lib/Drupal/Core/Routing/LinkGeneratorTrait.php
@@ -29,8 +29,10 @@
+   * @see \Drupal\Core\Utility\LinkGeneratorInterface::generate()

+++ b/core/lib/Drupal/Core/Routing/UrlGeneratorTrait.php
@@ -27,8 +27,10 @@
+   * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()

    Let's move these to be after the @return.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Status: Needs work » Needs review
FileSize
drupal-coding-standards-function-comment-see-references-issues-2716661-14.patch37.12 KB
interdiff-2716661-11-14.patch23.36 KB

Thanks for the quick review. I have made the changes related to moving @see to the end and have created the patch again.

interdiff ran into errors with it being not able to handle hunk-splitting and option -U was not working for me. Ran diff -c10 instead.

Status: Needs review » Needs work

The last submitted patch, 14: interdiff-2716661-11-14.patch, failed testing.

anoopjohn’s picture

anoopjohn CreditAttribution: anoopjohn at Zyxware Technologies commented
Status: Needs work » Needs review

The failure is a typo in the interdiff file extension. Hope that is alright.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Needs review » Reviewed & tested by the community
Issue tags: -Needs reroll

Looks good.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Reviewed & tested by the community » Fixed

Committed 53223f8 and pushed to 8.1.x and 8.2.x. Thanks!

  • alexpott committed 899f647 on 8.2.x 
    Issue #2716661 by anoopjohn: Fix 'Drupal.Commenting.FunctionComment'...

  • alexpott committed 53223f8 on 8.1.x 
    Issue #2716661 by anoopjohn: Fix 'Drupal.Commenting.FunctionComment'...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.