Fix functions and test modules for Drupal.Commenting.DocComment.ShortSingleLine

Ready fro reviews.

Tested this out by commenting out the phpcs line and running against the changes from the MR and got no errors.

Went back and read the descriptions and they look good to me.

Though am curious why

 * The strings wrapped in Drupal.t() and  Drupal.formatPlural() are extracted
 * and inserted into the database.

didn't fail?

@smustgrave, Thanks for rechecking!

To answer your question, tt is because it is not a summary line. It is only the summary line that must fit in 80 chars, https://www.drupal.org/docs/develop/standards/php/api-documentation-and-... →

Thanks for working on this. I added a number of suggestions to better match our documentation standards.

Remember, the one-line summary should:

1. Be a summary describing the function/module/etc. out of context.
2. Have the most important information first.
3. Start with a third-person indicative verb, e.g. "Gets" (not "get"). (There are a few exceptions with their own pattern: hook definitions, update functions, render API callbacks, etc.)
4. Be a complete, grammatically correct predicate (the part of a sentence after the verb).
5. Not omit small, grammatically required words like "a", "the", "that", etc.

Reference: https://www.drupal.org/node/1354 →

Please review the suggestions as you work through them; I am not infallible. :)

Changes look good,

14 is much easier to review then 96 haha

Added a couple more suggestions. "Test module" is not a helpful file docblock. One of the proposed docblocks also went against our coding standards by not having complete sentences.

Thanks!

I reviewed again and the one the uses 'implements' is a .module file with several hooks whereas the others have just one. So, the language changes make sense.

Taking another swing but the changes look fine to me. Would agree with the .module files as they be testing numerous things. Depends who's using them.

Committed and pushed 6629a1634d to 10.1.x and 94398eb858 to 10.0.x and cfd1219559 to 9.5.x. Thanks!

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