Problem/Motivation

There's a comment in demo_umami.profile which is exceeds the 80-characters per-line standard.

  // @todo: This can be removed once a generic warning for experimental profiles has been introduced.

Proposed resolution

Wrap the TODO comment over two lines, per our comment documentation standards.

Remaining tasks

Write a patch for demo_umami.profile

User interface changes

None.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#9 wrapped-comment-2979930-9.patch876 bytesabhaypai
#3 2979930-wrap_comments-3.patch772 bytesvishalkhode

Comments

andrewmacpherson created an issue. See original summary.

andrewmacpherson’s picture

andrewmacpherson commented

This is a good first-time contributor issue, to learn how to make a patch for an issue.

Polite request: if you already know how to make a patch, please leave this for a first-time contributor.

vishalkhode’s picture

vishalkhode commented
StatusFileSize
new 2979930-wrap_comments-3.patch772 bytes

Done. Please review patch.

vishalkhode’s picture

vishalkhode commented
Status: Active » Needs review
msankhala’s picture

msankhala commented
Status: Needs review » Reviewed & tested by the community

I can confirm the patch #3 applies cleanly and fixes 80 character line length issue as per IS.

andrewmacpherson’s picture

andrewmacpherson commented

Perfect, wraps the offending line at exactly 80 chars.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

Let's take this opportunity to format the @todo as per the coding standards - https://www.drupal.org/docs/develop/coding-standards/api-documentation-a...

So it should be:

  // @todo This can be removed once a generic warning for experimental profiles
  //   has been introduced. https://www.drupal.org/project/drupal/issues/2934374

And the inline @see should be removed. See https://api.drupal.org/api/drupal/core%21profiles%21demo_umami%21demo_um... - the inline @see doesn't work.

andrewmacpherson’s picture

andrewmacpherson commented

Thanks @alexpott

I didn't realize the issue URL can go inline here.

So we're collapsing @see into the @todo, so it's just one documentation tag.

abhaypai’s picture

abhaypai commented
Assigned: Unassigned » abhaypai
Status: Needs work » Needs review
StatusFileSize
new wrapped-comment-2979930-9.patch876 bytes

Though the patch is having 81 characters in second line according to the solution of @alexpott in comment #7
Here's the patch. Reference for creating patch taken from here

msankhala’s picture

msankhala commented
Status: Needs review » Reviewed & tested by the community

@paiabhay8 Thanks for your first d8 core patch. No, it isn't having 81 characters in the second line, It is having exactly 80 characters. When you put the cursor at the end of the line. The cursor is at the 81st position but the last character is at 80th position.

I can confirm the patch #9 applies cleanly and fixes the issue as per @alexpott suggestion in #7.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed 
diff --git a/core/profiles/demo_umami/demo_umami.profile b/core/profiles/demo_umami/demo_umami.profile
new mode 100755

Need to be careful with file permissions here - it should stay 644, but fixed that on commit.

Committed a4560fd and pushed to 8.6.x. Thanks!

  • catch committed a4560fd on 8.6.x 
    Issue #2979930 by visshu007, paiabhay8: Wrap comments at 80 chars in...

Status: Fixed » Closed (fixed)

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