WordPress.org
Get WordPress

Make WordPress Core

Opened 3 months ago

Closed 3 months ago

Last modified 2 months ago

#65512 closed defect (bug) (fixed)

Docs: Standardize capitalization in @throws InvalidArgumentException annotations in WP_Ability_Category

Reported by: jigar bhanushali Owned by: gziolo
Priority: normal Milestone: 7.1
Component: Abilities API Version:
Severity: normal Keywords: has-patch
Cc: Focuses: docs

Description

The PHPDoc blocks in WP_Ability_Category contain inconsistent capitalization in the @throws descriptions.

This patch updates the @throws InvalidArgumentException annotations to follow WordPress documentation standards by capitalizing the first word of the description:

@throws InvalidArgumentException If an argument is invalid.

Affected methods:

WP_Ability_Category::__construct()
WP_Ability_Category::prepare_properties()

Attachments (1)

65512.diff​ (1.2 KB ) - added by jigar bhanushali 3 months ago.

Download all attachments as: .zip

Change History (5)

@jigar bhanushali
3 months ago

#1 @gziolo
3 months ago

  • Milestone Awaiting Review → 7.1
  • Owner set to gziolo
  • Status new → assigned

#2 @gziolo
3 months ago

  • Resolution → fixed
  • Status assigned → closed

In 62552:

Docs: Document exceptions in WP_Ability_Category

Adds a missing @throws annotation to WP_Ability_Category::__construct() and normalizes capitalization for the existing @throws description in WP_Ability_Category::prepare_properties().

Props igar-bhanushali.
Fixes #65512.

#3 @jigar bhanushali
2 months ago

@gziolo Props username is wrong, it should be jigar-bhanushali instead of igar-bhanushali

Last edited 2 months ago by jigar bhanushali (previous) (diff)

#4 @gziolo
2 months ago

@jigar-bhanushali, sorry about that. I included you in props in another commit [62555]. Hope that's all correct now :)

Note: See TracTickets for help on using tickets.