API page: https://api.drupal.org/api/drupal/core%21modules%21image%21src%21ImageEf...

The first line of docs needs to fit on a single line. The docs for this overrun to a second line.

CommentFileSizeAuthor
#5 interdiff-2923670-2-5.txt566 bytesduozersk
#5 first_line_of_docs-2923670-5.patch673 bytesduozersk
#2 2923670-2.patch670 bytessavkaviktor16@gmail.com

Comments

joachim created an issue. See original summary.

savkaviktor16@gmail.com’s picture

savkaviktor16@gmail.com commented
Status: Active » Needs review
StatusFileSize
new 2923670-2.patch670 bytes

I hope I didn't break the logical meaning of this doc comment

claudiu.cristea’s picture

claudiu.cristea
Primary language Romanian
Location Arad 🇷🇴
commented
Status: Needs review » Reviewed & tested by the community
joachim’s picture

joachim commented
Status: Reviewed & tested by the community » Needs work

> + * Returns the extension the derivative after applying this image effect.

Doesn't quite read right.

duozersk’s picture

duozersk
he/him
Primary language Russian
Location Moscow
commented
Status: Needs work » Needs review
StatusFileSize
new first_line_of_docs-2923670-5.patch673 bytes
new interdiff-2923670-2-5.txt566 bytes
somepal’s picture

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

Last patch good to go.. reviewed

xjm’s picture

xjm
she/her
Primary language English
commented
Title: first line of docs for ImageEffectInterface::getDerivativeExtension() overruns » first line of docs for ImageEffectInterface::getDerivativeExtension() is too long
Version: 8.5.x-dev » 8.4.x-dev
xjm’s picture

xjm
she/her
Primary language English
commented
Title: first line of docs for ImageEffectInterface::getDerivativeExtension() is too long » The one-line summary of ImageEffectInterface::getDerivativeExtension() is too long

  • xjm committed e59a03d on 8.5.x 
    Issue #2923670 by duozersk, Saviktor, joachim: The one-line summary of...

  • xjm committed fab8ea6 on 8.4.x 
    Issue #2923670 by duozersk, Saviktor, joachim: The one-line summary of...
xjm’s picture

xjm
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Normally I'd close this as a duplicate of #2572709: [meta] Fix 'Drupal.Files.LineLength' coding standard, but getting a one-line summary under 80 characters requires rewriting it rather than rewrapping it, so in this case I think it's okay. (Note that normally though we should fix one coding standard rule across all of core and then enable the rule in the phpcs.xml.dist, rather than fixing a single instance.)

Committed and pushed to 8.5.x. Thanks! I also backported this to 8.4.x as a documentation fix.

Status: Fixed » Closed (fixed)

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