Problem/Motivation

Some @return and @param type hints contain FQCN with upper case module namespace.

Steps to reproduce

Proposed resolution

Use correct case for module namespaces.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3562676

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

znerol created an issue. See original summary.

znerol opened merge request !14092

znerol’s picture

znerol commented
Status: Active » Needs review
smustgrave’s picture

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

Seems pretty straight forward

znerol’s picture

znerol commented

I found one more instance with the following regex(es):

git grep -h -o ' \\Drupal\\[A-Z][\\A-Za-z0-9]*' | grep -v '\\Drupal\\Core' | grep -v '\\Drupal\\Component' | grep -v '\\Drupal\\Composer' | grep -v '\\Drupal\\[^\\]*Test[^\\]'

xjm’s picture

xjm
she/her
Primary language English
commented

I also did a visual scan of the grep results without excluding those with Test in the namespace (i.e., the above grep without the last bit after the last pipe). There were a couple out of scope raised eyebrows, but once I realized it was splitting on _ things made more sense. I will be filing a couple followups for out-of-scope issues with other namespaces, but I didn't identify any incorrectly uppercased module names in test class namespaces on visual scan of the grep results.

  • xjm committed bd260abe on 11.x 
    fix: #3562676 Fix type hints with wrong case in @param and @return...

  • xjm committed b81315d6 on 11.3.x 
    fix: #3562676 Fix type hints with wrong case in @param and @return...
xjm’s picture

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

Committed to 11.x, and cherry-picked to 11.3.x as a patch-safe documentation fix. Thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

xjm closed merge request !14092

Status: Fixed » Closed (fixed)

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