Fix the issues reported by phpcs

Created on 21 July 2023, 11 months ago
Updated 25 July 2023, 11 months ago

Problem/Motivation

FILE: /Users/roberttabigue/Projects/drupalorgissues/docroot/modules/contrib/smart_trim_readmore/smart_trim_readmore.module
--------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
--------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------


FILE: /Users/roberttabigue/Projects/drupalorgissues/docroot/modules/contrib/smart_trim_readmore/src/Truncate/ExtraTruncateHTML.php
----------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
----------------------------------------------------------------------------------------------------------------------------------
  9 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
 40 | ERROR   | Description for the @return value is missing
----------------------------------------------------------------------------------------------------------------------------------

Time: 204ms; Memory: 10MB

Steps to reproduce

Please execute this command on the module:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig smart_trim_readmore/

๐Ÿ“Œ Task
Status

RTBC

Version

1.0

Component

Code

Created by

๐Ÿ‡ต๐Ÿ‡ญPhilippines roberttabigue

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

  • Issue created by @roberttabigue
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • @anjali-mehta opened merge request.
  • Status changed to Needs review 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Hello
    I have created a MR to solve all the errors.
    Kindly review.
    Thank You.

  • Status changed to RTBC 11 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines roberttabigue

    Hi,

    I applied the latest MR !2 to the Smart Trim Readmore module against 8.x-1.x-dev on Drupal 9.5.10 and confirmed all PHPCS errors have been fixed.

    I re-ran this command on the module:
    phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig smart_trim_readmore/

    Please see the attached file for reference.

    I'm moving this now to RTBC.

    Thank you!

Production build 0.69.0 2024