Typo in PHPDoc for uswds_base_preprocess_block__block_content__hero()

Created on 24 July 2023, 11 months ago
Updated 20 September 2023, 9 months ago

Problem/Motivation

I'm trying to figure out how to add a Hero and was browsing the templates and preprocess functions when I tried to follow a link in the PHPDoc for uswds_base_preprocess_block__block_content__hero(). It suggested I go to uswds_theme_suggestions_block_alter(), but that function doesn't exist (at least, in uswds_base). The correct function is named uswds_base_theme_suggestions_block_alter(). This patch is just to fix the function name in that reference.

Steps to reproduce

  1. Open uswds_base in an IDE that follows @see references, such as PHPStorm
  2. Navigate to preprocess/block/block__block_content__hero.preprocess.inc
  3. Click on @see uswds_theme_suggestions_block_alter()
  4. Verify error Cannot find declaration to go to, or similar

Proposed resolution

I will provide a patch to remedy this issue.

Remaining tasks

Once the patch is applied, just test whether the declaration is found.

User interface changes

None.

API changes

None.

Data model changes

None.

πŸ› Bug report
Status

Fixed

Version

3.4

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States josephcheek Salt Lake City, UT

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

Comments & Activities

Production build 0.69.0 2024