Description for the @return value is missing

Created on 25 February 2023, over 2 years ago

Problem/Motivation

FILE: ...l/drupal_9.4/drupal/web/modules/contrib/mixpanel/src/Form/SettingsForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
41 | WARNING | [x] A comma should follow the last multiline array item. Found:
| | )
--------------------------------------------------------------------------------

FILE: ...html/drupal_9.4/drupal/web/modules/contrib/mixpanel/src/MixpanelClient.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
39 | ERROR | Description for the @return value is missing
--------------------------------------------------------------------------------

Time: 1.81 secs; Memory: 10MB

📌 Task
Status

Active

Version

2.0

Component

Code

Created by

🇮🇳India Rohit Rana

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @Rohit Rana
  • Issue was unassigned.
  • Status changed to Needs review over 2 years ago
  • Status changed to Needs work about 2 years ago
  • 🇦🇺Australia darvanen Sydney, Australia

    Thanks for starting this @Rohit Rana, however - I have implemented a personal policy of only providing credit for code standards updates to new contributers who have not already recieved a credit for code standards updates, so I will be removing credit from this issue.

    Also, please do not open coding standards updates with a specific title for an individial problem. Open a single issue for ALL required code standards fixes unless the module is so gigantic that it becomes impossible to manage. I have changed this issue to that effect.

    Finally, I would also like to point out that rather than blindly following the suggestion provided by phpcs regarding the @return value documentation, if there is nothing specific to write in said documentation, the return typehint should suffice and the doc-comment can be deleted which will also satisfy phpcs.

  • 🇦🇺Australia darvanen Sydney, Australia

    Now that GitLab CI is in place and it's standard practice for contrib modules to include PHPCS tests I'm retracting my credit policy. All normal credits will be applied for this issue.

  • Merge request !5Satisfy phpcs → (Merged) created by darvanen
  • 🇦🇺Australia darvanen Sydney, Australia
    • darvanen committed 16e5f219 on 2.x
      Issue #3344391 by rohit rana, darvanen: Code standards updates
      
Production build 0.71.5 2024