Problem/Motivation

The sniff "Drupal.Commenting.DocComment.ParamNotFirst" is not enabled.

Steps to reproduce

Proposed resolution

Enable the run "Drupal.Commenting.DocComment.ParamNotFirst" in core/phpcs.xml.dist

Remaining tasks

Create a follow up to fix and then remove the two ignore lines added here.

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#6 2937558-6.patch3.61 KBjungle

Issue fork drupal-2937558

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

eltori created an issue. See original summary.

ivan berezhnov’s picture

ivan berezhnov commented
Issue tags: +CSKyiv18

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

jungle’s picture

jungle
He/Him
Location Chongqing, China
commented
StatusFileSize
new 2937558-6.patch3.61 KB

Submit an incomplete patch for further discussion

jungle’s picture

jungle
He/Him
Location Chongqing, China
commented 
+++ b/core/includes/file.inc
@@ -417,7 +417,7 @@ function file_valid_uri($uri) {
  * - Works around a PHP bug where copy() does not properly support streams if
  *   safe_mode or open_basedir are enabled.
- *   @see https://bugs.php.net/bug.php?id=60456

@@ -602,7 +602,7 @@ function file_destination($destination, $replace) {
  * - Works around a PHP bug where rename() does not properly support streams if
  *   safe_mode or open_basedir are enabled.
- *   @see https://bugs.php.net/bug.php?id=60456
+ *   See https://bugs.php.net/bug.php?id=60456

+++ b/core/lib/Drupal/Core/Asset/AssetResolverInterface.php
+++ b/core/lib/Drupal/Core/Asset/AssetResolverInterface.php
@@ -27,7 +27,7 @@ interface AssetResolverInterface {

@@ -27,7 +27,7 @@ interface AssetResolverInterface {
    * - CSS_COMPONENT
    * - CSS_STATE
    * - CSS_THEME
-   * @see https://www.drupal.org/node/1887918#separate-concerns
+   * See https://www.drupal.org/node/1887918#separate-concerns

Is it ok to change @see to See for the samples above? The context of them is not pointing to its function/method directly.

idebr’s picture

idebr commented

The @see tag can be used to define a reference to other Structural Elements or to an URI.

https://docs.phpdoc.org/latest/references/phpdoc/tags/see.html

@see can point to URLs. If the URL should be displayed inline, you can convert them to use @link: https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutori...

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Assigned: eltori » Unassigned

Un-assigning, it seem eltori created the issue but hasn't worked on it since.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Parent issue: #2571965: [meta] Fix PHP coding standards in core, stage 1 » #3464117: [meta] Fix 'Drupal.Commenting.DocComment' coding standard

quietone opened merge request !8955

quietone’s picture

quietone commented
Issue summary: View changes
longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Active » Needs work

This needs a reroll but I think this is fine to go in as-is, not sure what there is to discuss (as per the OP).

quietone’s picture

quietone commented
Status: Needs work » Needs review
smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +Needs Review Queue Initiative

Rebase seems good. Not sure what else to review, the rule being enabled showed everything and don't see anything off.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented

I had a question on the MR, but I don't feel strongly enough about it to un-rtbc this.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Needs review

hmm I think @borisson_ is right - if we don't want to make that documentation compliant with the rule, then either the coding standard or the rule should change so it doesn't need to be ignored.

quietone’s picture

quietone commented
Issue summary: View changes
borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented
Status: Needs review » Reviewed & tested by the community

#24 sounds very reasonable.

nod_ made their first commit to this issue’s fork.

nod_ closed merge request !8955

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Reviewed & tested by the community » Needs review

question in MR

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
commented

I think you closed the merge request, but yes, I think we should.

quietone reopened merge request !8955

nod_’s picture

nod_
Primary language French
Location Lille
commented

ah yes sorry, was about to commit when i spotted it :),thx quietone

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Needs review » Reviewed & tested by the community

thx for the update

nod_ closed merge request !8955

  • nod_ committed 68bf822f on 11.x 
    Issue #2937558 by quietone, nod_, jungle, borisson_, longwave, catch,...
nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Reviewed & tested by the community » Fixed

Committed 68bf822 and pushed to 11.x. Thanks!

Status: Fixed » Closed (fixed)

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