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

Issue fork backup_migrate-3357392

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

Akshay kashyap created an issue. See original summary.

akshay kashyap’s picture

akshay kashyap commented
Status: Active » Needs work
vimal_nadar’s picture

vimal_nadar commented
Assigned: Unassigned » vimal_nadar

I will work on this

vimal_nadar opened merge request !31

vimal_nadar’s picture

vimal_nadar commented
Assigned: vimal_nadar » Unassigned
Status: Needs work » Needs review

Created a MR request. Please review it.

akshay kashyap’s picture

akshay kashyap commented 
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
akshay kashyap’s picture

akshay kashyap commented
Status: Needs review » Needs work

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

akshay kashyap’s picture

akshay kashyap commented
Status: Needs work » Needs review
damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Needs review » Needs work

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.

ravi kant made their first commit to this issue’s fork.

ravi kant’s picture

ravi kant commented
Status: Needs work » Needs review

Updated Readme file according README Template

ivnish’s picture

ivnish
he/him
commented
Category: Bug report » Task
ivnish’s picture

ivnish
he/him
commented
Status: Needs review » Needs work

Seems feedback from #9 was not addressed.

danrod’s picture

danrod
Location Ottawa
commented
Assigned: Unassigned » danrod

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

yusuf_khan’s picture

yusuf_khan commented
Status: Needs work » Needs review

Updated MR !31 to address the feedback from #9.

Changes made:
- Rewrapped README prose and examples for cleaner 80-column formatting.
- Fixed wrapped code comments so continuation lines include the comment prefix.
- Cleaned up grammar, spacing, punctuation, and unclear sentences.
- Fixed broken or invalid code examples in the README files.

Tested locally:
- phpcs --standard=Drupal,DrupalPractice --extensions=md README.md src/Core/*/README.md
- git diff --check

Both pass.

@danrod Please review.

ivnish’s picture

ivnish
he/him
commented
Assigned: danrod » Unassigned
danrod’s picture

danrod
Location Ottawa
commented

Thanks @yusuf_khan, I tested locally by running phpcs:

$ phpcs --standard=Drupal,DrupalPractice --extensions=md README.md src/Core/*/README.md

and got no warnings or errors, this can be moved to RTBC.

danrod’s picture

danrod
Location Ottawa
commented
Status: Needs review » Reviewed & tested by the community

  • danrod committed 43a68549 on 5.1.x authored by vimal_nadar 
    Issue #3357392: Address coding standard issues in README.md file that...
danrod’s picture

danrod
Location Ottawa
commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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