Problem/Motivation
line exceed 80 characters.

Please fix coding issue according Drupal coding standard.

Proposed resolution

Fix coding standard issue.

CommentFileSizeAuthor
#4 3111549-4-word_monitor_md_line_length.patch6.09 KBalberto56
#2 3111549-2.patch5.5 KBswatichouhan012
word_monitor_readme.png PNG Image 1600 × 900 pixels .png437.38 KBswatichouhan012

Comments

swatichouhan created an issue. See original summary.

swatichouhan012’s picture

swatichouhan012 commented
Status: Active » Needs review
StatusFileSize
new 3111549-2.patch5.5 KB

Here is the patch to fix README.md coding standard issues. Kindly review.

dhirendra.mishra’s picture

dhirendra.mishra commented

+1 for RTBC

alberto56’s picture

alberto56 commented
Category: Bug report » Task
StatusFileSize
new 3111549-4-word_monitor_md_line_length.patch6.09 KB

Hi, thanks for the patch.

I'll set this to "task" rather than bug report because it does not change how the module is used.

I'm kind of on the fence about wrapping vs. not wrapping markdown lines to 80 characters, [this article](https://about.gitlab.com/blog/2016/10/11/wrapping-text/) is an interesting resource for that.

That being said, I will apply your patch with a few changes:

* I added linting using https://github.com/dcycle/docker-markdown-lint to catch these types of issues during the CI process, however the results are slightly different from the tool you are using.
* According to markdownlint, the first line on a file should be a header, which I did.
* Hyperlinks should not be split into two lines even if the lines are then longer than 80 characters.
* When you split lines in a list, every subsequent line should have 2, not 0, preceding spaces, for the github markdown parser to properly interpret them.

Enclosed is a new version of the patch.

The [tests are all passing on CicleCI](https://circleci.com/gh/dcycle/word_monitor/12).

  • alberto56 committed 8fcf19a on 8.x-1.x 
    Issue #3111549 by swatichouhan, alberto56: Fix Coding Standard Issue
alberto56’s picture

alberto56 commented
Status: Needs review » Fixed

Committed, thanks!

Status: Fixed » Closed (fixed)

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