Let ShortNotCapital allow starting with some characters that do not have case

Created on 28 June 2021, almost 4 years ago
Updated 22 February 2025, about 1 month ago

Problem/Motivation

Allow Drupal.Commenting.DocComment.ShortNotCapital to accept some starting characters that do not have case.

Examples in core are

  • (optional)
  • ::render() may be called from anywhere.
  • #lazy_builder callback; attaches setting, generates markup.
  • (proxied) Implements hook_preprocess_HOOK().

Of those examples, (optional) is not popular #2925237: ShortNotCapital triggered by non-letters ), catch said that #lazy_build should be allowed.
Not sure about the others.

Steps to reproduce

Proposed resolution

Do not allow

  • (optional)

Allow

  • #

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

🐛 Bug report
Status

Active

Version

3.0

Component

Coder Sniffer

Created by

🇳🇿New Zealand quietone

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇳🇿New Zealand quietone

    I am not sure about this.The standard states

    All summaries (first lines of docblocks) must be under 80 characters, start with a capital letter, and end with a period (.).

    The examples in the issue summary are actually not correct summary lines, and not just because of the first letter. They also do not meet the standard that "All documentation and comments should form proper sentences, use proper grammar and punctuation". And one of them is for a callback which has a completely different format which requires two separate lines.

Production build 0.71.5 2024