Address coding standard issues in README.md file that trigger warning messages

Created on 1 May 2023, over 1 year ago
Updated 20 February 2024, 10 months ago

Getting the following warnings messages in README.md file

FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Plugin/README.md
----------------------------------------------------------------------------------
FOUND 0 ERRORS AND 22 WARNINGS AFFECTING 22 LINES
----------------------------------------------------------------------------------
   3 | WARNING | Line exceeds 80 characters; contains 182 characters
   9 | WARNING | Line exceeds 80 characters; contains 82 characters
  10 | WARNING | Line exceeds 80 characters; contains 95 characters
  11 | WARNING | Line exceeds 80 characters; contains 117 characters
  13 | WARNING | Line exceeds 80 characters; contains 91 characters
  16 | WARNING | Line exceeds 80 characters; contains 226 characters
  21 | WARNING | Line exceeds 80 characters; contains 265 characters
  26 | WARNING | Line exceeds 80 characters; contains 302 characters
  32 | WARNING | Line exceeds 80 characters; contains 183 characters
  37 | WARNING | Line exceeds 80 characters; contains 228 characters
  41 | WARNING | Line exceeds 80 characters; contains 135 characters
  51 | WARNING | Line exceeds 80 characters; contains 119 characters
  61 | WARNING | Line exceeds 80 characters; contains 448 characters
  64 | WARNING | Line exceeds 80 characters; contains 318 characters
  67 | WARNING | Line exceeds 80 characters; contains 417 characters
  69 | WARNING | Line exceeds 80 characters; contains 230 characters
  79 | WARNING | Line exceeds 80 characters; contains 364 characters
  81 | WARNING | Line exceeds 80 characters; contains 494 characters
  92 | WARNING | Line exceeds 80 characters; contains 425 characters
  94 | WARNING | Line exceeds 80 characters; contains 360 characters
 107 | WARNING | Line exceeds 80 characters; contains 321 characters
 127 | WARNING | Line exceeds 80 characters; contains 448 characters
----------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Destination/README.md
---------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 6 WARNINGS AFFECTING 6 LINES
---------------------------------------------------------------------------------------
  3 | WARNING | Line exceeds 80 characters; contains 224 characters
  5 | WARNING | Line exceeds 80 characters; contains 279 characters
  7 | WARNING | Line exceeds 80 characters; contains 148 characters
  9 | WARNING | Line exceeds 80 characters; contains 158 characters
 11 | WARNING | Line exceeds 80 characters; contains 81 characters
 13 | WARNING | Line exceeds 80 characters; contains 366 characters
---------------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Source/README.md
----------------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
----------------------------------------------------------------------------------
 3 | WARNING | Line exceeds 80 characters; contains 356 characters
 5 | WARNING | Line exceeds 80 characters; contains 143 characters
 7 | WARNING | Line exceeds 80 characters; contains 261 characters
 9 | WARNING | Line exceeds 80 characters; contains 161 characters
----------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Main/README.md
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 25 WARNINGS AFFECTING 25 LINES
--------------------------------------------------------------------------------
   3 | WARNING | Line exceeds 80 characters; contains 127 characters
   4 | WARNING | Line exceeds 80 characters; contains 116 characters
   9 | WARNING | Line exceeds 80 characters; contains 118 characters
  10 | WARNING | Line exceeds 80 characters; contains 115 characters
  11 | WARNING | Line exceeds 80 characters; contains 116 characters
  21 | WARNING | Line exceeds 80 characters; contains 114 characters
  22 | WARNING | Line exceeds 80 characters; contains 304 characters
  23 | WARNING | Line exceeds 80 characters; contains 127 characters
  24 | WARNING | Line exceeds 80 characters; contains 98 characters
  63 | WARNING | Line exceeds 80 characters; contains 119 characters
  64 | WARNING | Line exceeds 80 characters; contains 118 characters
  65 | WARNING | Line exceeds 80 characters; contains 119 characters
  66 | WARNING | Line exceeds 80 characters; contains 113 characters
  74 | WARNING | Line exceeds 80 characters; contains 105 characters
  84 | WARNING | Line exceeds 80 characters; contains 517 characters
  97 | WARNING | Line exceeds 80 characters; contains 116 characters
  98 | WARNING | Line exceeds 80 characters; contains 95 characters
 100 | WARNING | Line exceeds 80 characters; contains 107 characters
 101 | WARNING | Line exceeds 80 characters; contains 123 characters
 102 | WARNING | Line exceeds 80 characters; contains 89 characters
 117 | WARNING | Line exceeds 80 characters; contains 114 characters
 118 | WARNING | Line exceeds 80 characters; contains 84 characters
 120 | WARNING | Line exceeds 80 characters; contains 107 characters
 121 | WARNING | Line exceeds 80 characters; contains 117 characters
 122 | WARNING | Line exceeds 80 characters; contains 119 characters
--------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/File/README.md
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 8 WARNINGS AFFECTING 8 LINES
--------------------------------------------------------------------------------
  3 | WARNING | Line exceeds 80 characters; contains 295 characters
 11 | WARNING | Line exceeds 80 characters; contains 200 characters
 16 | WARNING | Line exceeds 80 characters; contains 550 characters
 19 | WARNING | Line exceeds 80 characters; contains 287 characters
 37 | WARNING | Line exceeds 80 characters; contains 743 characters
 40 | WARNING | Line exceeds 80 characters; contains 704 characters
 44 | WARNING | Line exceeds 80 characters; contains 243 characters
 56 | WARNING | Line exceeds 80 characters; contains 156 characters
--------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Config/README.md
----------------------------------------------------------------------------------
FOUND 3 ERRORS AND 4 WARNINGS AFFECTING 7 LINES
----------------------------------------------------------------------------------
  1 | ERROR   | [x] Missing file doc comment
  3 | WARNING | [ ] Line exceeds 80 characters; contains 591 characters
  5 | WARNING | [ ] Line exceeds 80 characters; contains 388 characters
  8 | WARNING | [ ] Line exceeds 80 characters; contains 171 characters
 36 | WARNING | [ ] Line exceeds 80 characters; contains 96 characters
 56 | ERROR   | [x] Concat operator must be surrounded by a single space
 58 | ERROR   | [x] list(...) is forbidden, use [...] instead.
----------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Service/README.md
-----------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
-----------------------------------------------------------------------------------
  3 | WARNING | Line exceeds 80 characters; contains 168 characters
 11 | WARNING | Line exceeds 80 characters; contains 299 characters
 13 | WARNING | Line exceeds 80 characters; contains 196 characters
-----------------------------------------------------------------------------------


FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
----------------------------------------------------------------------
  9 | WARNING | Line exceeds 80 characters; contains 124 characters
 10 | WARNING | Line exceeds 80 characters; contains 92 characters
----------------------------------------------------------------------

Time: 40ms; Memory: 8MB
๐Ÿ› Bug report
Status

Needs review

Version

5.1

Component

Code

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Akshay kashyap

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

Merge Requests

Comments & Activities

  • Issue created by @Akshay kashyap
  • Assigned to vimal_nadar
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vimal_nadar

    I will work on this

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.5 + Environment: PHP 8.0 & MySQL 5.7
    last update over 1 year ago
    25 pass
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia vimal_nadar

    Created a MR request. Please review it.

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.5 + Environment: PHP 8.0 & MySQL 5.7
    last update over 1 year ago
    25 pass
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Akshay kashyap

    FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Config/README.md
    ----------------------------------------------------------------------------------
    FOUND 8 ERRORS AFFECTING 7 LINES
    ----------------------------------------------------------------------------------
    1 | ERROR | [x] Missing file doc comment
    73 | ERROR | [x] Concat operator must be surrounded by a single space
    74 | ERROR | [x] Concat operator must be surrounded by a single space
    76 | ERROR | [x] Concat operator must be surrounded by a single space
    78 | ERROR | [x] Concat operator must be surrounded by a single space
    80 | ERROR | [x] Concat operator must be surrounded by a single space
    80 | ERROR | [x] list(...) is forbidden, use [...] instead.
    82 | ERROR | [x] Concat operator must be surrounded by a single space
    ----------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ----------------------------------------------------------------------------------

    FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/src/Core/Service/README.md
    -----------------------------------------------------------------------------------
    FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
    -----------------------------------------------------------------------------------
    3 | WARNING | Line exceeds 80 characters; contains 168 characters
    11 | WARNING | Line exceeds 80 characters; contains 299 characters
    13 | WARNING | Line exceeds 80 characters; contains 196 characters
    -----------------------------------------------------------------------------------

    FILE: /home/gai/drupal-git/drupal/modules/backup_migrate/README.md
    ----------------------------------------------------------------------
    FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
    ----------------------------------------------------------------------
    9 | WARNING | Line exceeds 80 characters; contains 124 characters
    10 | WARNING | Line exceeds 80 characters; contains 92 characters
    ----------------------------------------------------------------------

    Time: 40ms; Memory: 8MB

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.5 + Environment: PHP 8.0 & MySQL 5.7
    last update over 1 year ago
    25 pass
  • Status changed to Needs work over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Akshay kashyap

    Created a MR request to fixed the Concat operator must be surrounded by a single space & WARNING | Line exceeds 80 characters;

  • Status changed to Needs review over 1 year ago
  • Status changed to Needs work over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States DamienMcKenna NH, USA

    This needs work:
    * Comments are not filled out to line 80 with many examples wrapping well short of that.
    * Code comments that are wrapped at line 80 are not given the comment prefix.
    * Sentences should be written in proper English with appropriate punctuation, e.g. no spaces between words and the period at the end.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    ravi kant โ†’ made their first commit to this issueโ€™s fork.

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.5 + Environment: PHP 8.0 & MySQL 5.7
    last update 10 months ago
    25 pass
  • Status changed to Needs review 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    Updated Readme file according README Template โ†’

Production build 0.71.5 2024