Address code quality issue discovered by the phpcs test in our gitlab CI integration.

Created on 19 March 2025, 14 days ago

Problem/Motivation

PHPCS test failing.

Steps to reproduce

Go to: https://git.drupalcode.org/project/search_current_language/-/jobs/4484396

See

FILE: ...web/modules/custom/search_current_language/search_current_language.install
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 5 | ERROR | [x] Doc comment short description must start with a capital letter
   |       |     (Drupal.Commenting.DocComment.ShortNotCapital)
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------
Time: 121ms; Memory: 6MB
PHP CODE SNIFFER REPORT SUMMARY
--------------------------------------------------------------------------------
FILE                                                            ERRORS  WARNINGS
--------------------------------------------------------------------------------
...tom/search_current_language/search_current_language.install  1       0
--------------------------------------------------------------------------------
A TOTAL OF 1 ERROR AND 0 WARNINGS WERE FOUND IN 2 FILES
--------------------------------------------------------------------------------
PHPCBF CAN FIX 1 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------
PHP CODE SNIFFER VIOLATION SOURCE SUMMARY
----------------------------------------------------------------------
    SOURCE                                                       COUNT
----------------------------------------------------------------------
[x] Drupal.Commenting.DocComment.ShortNotCapital                 1
----------------------------------------------------------------------
A TOTAL OF 1 SNIFF VIOLATION WERE FOUND IN 1 SOURCE
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SOURCES AUTOMATICALLY (1 VIOLATIONS IN TOTAL)
----------------------------------------------------------------------

Proposed resolution

Ensure all code comments are OK.

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report

Status

Active

Version

1.0

Component

Code

Created by

🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

Live updates comments and jobs are added and updated live.

Merge Requests

!7Address code quality issue discovered by the phpcs test in our gitlab CI integration.
Merged
🇺🇸United States trackleft2
updated 7 days ago

Comments & Activities

Issue created by @trackleft2
Comment 14 days ago →
🇺🇸United States trackleft2 Tucson, AZ 🇺🇸
Merge request !7Issue #3514185 Resolve issues with code comments discovered by the PHPCS test... → (Merged) created by trackleft2
Comment 14 days ago →
🇺🇸United States trackleft2 Tucson, AZ 🇺🇸
Pipeline finished with Success
14 days ago
Total: 148s
#452692
First commit to issue fork.
Comment 7 days ago →
System Message

jmauricio → committed 9a45c7ad on 1.0.x authored by trackleft2 →
Issue #3514185 Resolve issues with code comments discovered by the PHPCS...
Comment 6 days ago →
🇵🇹Portugal jmauricio
Merged into 1.0.x

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024