Differential D25958

PHPDoc: Fix @return string for methods which can also return null
ClosedPublic
Actions

Authored by aklapper on Apr 11 2025, 09:51.

Details

Reviewers

valerio.bozzolan

Group Reviewers

O1: Blessed Committers

Commits

rP403fb8a85214: PHPDoc: Fix @return string for methods which can also return null

Summary

Correct docs.

Test Plan

Read the method code, run static code analysis (PHPStan) which complains "should return string but returns null".

Diff Detail

Repository

rP Phorge

Branch

phpDocReturnStringNull (branched from master)

Lint

Lint Passed

Unit

Tests Passed

Build Status

Buildable 1859
Build 1859: arc lint + arc unit

Event Timeline

aklapper created this revision.Apr 11 2025, 09:51

Owners added a reviewer: O1: Blessed Committers.Apr 11 2025, 09:51

Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan, tobiaswiese. · View Herald TranscriptApr 11 2025, 09:51

aklapper requested review of this revision.Apr 11 2025, 09:51

Harbormaster completed remote builds in B1859: Diff 2861.Apr 11 2025, 09:51

yesyes

This revision is now accepted and ready to land.Apr 23 2025, 13:02

Closed by commit rP403fb8a85214: PHPDoc: Fix @return string for methods which can also return null. · Explain WhyApr 24 2025, 05:59

This revision was automatically updated to reflect the committed changes.

aklapper added a commit: rP403fb8a85214: PHPDoc: Fix @return string for methods which can also return null.

Revision Contents
Changeset List

Path

Size

Coverage (All)

Coverage (Touched)

Packages

src/

aphront/

configuration/

AphrontApplicationConfiguration.php

4 lines

O1: Blessed Committers

httpparametertype/

AphrontHTTPParameterType.php

2 lines

O1: Blessed Committers

applications/

auth/

constants/

PhabricatorCookies.php

5 lines

O1: Blessed Committers

config/

option/

PhabricatorApplicationConfigOptions.php

2 lines

O1: Blessed Committers

diffusion/

request/

DiffusionRequest.php

8 lines

O1: Blessed Committers

metamta/

command/

MetaMTAEmailTransactionCommand.php

2 lines

25%

O1: Blessed Committers

phame/

storage/

PhameBlog.php

4 lines

O1: Blessed Committers

policy/

capability/

PhabricatorPolicyCapability.php

4 lines

90%

O1: Blessed Committers

transactions/

editfield/

PhabricatorEditField.php

2 lines

O1: Blessed Committers

infrastructure/

customfield/

field/

PhabricatorCustomField.php

7 lines

13%

O1: Blessed Committers

edges/

query/

PhabricatorEdgeQuery.php

2 lines

58%

O1: Blessed Committers

query/

policy/

PhabricatorCursorPagedPolicyAwareQuery.php

5 lines

22%

O1: Blessed Committers

Diff 2861

View Options

src/aphront/configuration/AphrontApplicationConfiguration.php

View Options

src/aphront/httpparametertype/AphrontHTTPParameterType.php

View Options

src/applications/auth/constants/PhabricatorCookies.php

View Options

src/applications/config/option/PhabricatorApplicationConfigOptions.php

View Options

src/applications/diffusion/request/DiffusionRequest.php

View Options

src/applications/metamta/command/MetaMTAEmailTransactionCommand.php

View Options

src/applications/phame/storage/PhameBlog.php

View Options

src/applications/policy/capability/PhabricatorPolicyCapability.php

View Options

src/applications/transactions/editfield/PhabricatorEditField.php

View Options

src/infrastructure/customfield/field/PhabricatorCustomField.php

View Options

src/infrastructure/edges/query/PhabricatorEdgeQuery.php

View Options

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

PHPDoc: Fix @return string for methods which can also return nullClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 2861

src/aphront/configuration/AphrontApplicationConfiguration.php

src/aphront/httpparametertype/AphrontHTTPParameterType.php

src/applications/auth/constants/PhabricatorCookies.php

src/applications/config/option/PhabricatorApplicationConfigOptions.php

src/applications/diffusion/request/DiffusionRequest.php

src/applications/metamta/command/MetaMTAEmailTransactionCommand.php

src/applications/phame/storage/PhameBlog.php

src/applications/policy/capability/PhabricatorPolicyCapability.php

src/applications/transactions/editfield/PhabricatorEditField.php

src/infrastructure/customfield/field/PhabricatorCustomField.php

src/infrastructure/edges/query/PhabricatorEdgeQuery.php

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

PHPDoc: Fix @return string for methods which can also return null
ClosedPublic
Actions

Revision Contents
Changeset List