Page MenuHomeDevCentral

Improve documentation and code types coherence
ClosedPublic

Authored by dereckson on Dec 26 2016, 02:55.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 12, 05:17
Unknown Object (File)
Mon, Nov 11, 20:29
Unknown Object (File)
Sun, Nov 10, 14:39
Unknown Object (File)
Sat, Nov 9, 23:20
Unknown Object (File)
Sat, Nov 9, 17:14
Unknown Object (File)
Sat, Nov 9, 15:20
Unknown Object (File)
Sat, Nov 9, 10:30
Unknown Object (File)
Sat, Nov 9, 08:35
Subscribers

Details

Summary

We use the phan static analysis tool to detect divergences
between types in the documentation and the source code.

Types given in absolute namespace notation are now prepended with \.
When the type is in the current namespace, relative notation is used.

The new PHP 7.1 pseudo-type iterable has been chosen to use with
PhabricatorStory, as there is no need for the payload sent by
Phabricator API to be an array.

This is no-op as only method signatures and documentation is updated.

Test Plan

phan | grep PhanTypeMismatch

Diff Detail

Repository
rNOTIF Notifications center
Lint
Lint Passed
Unit
Tests Passed
Branch
improve-returning-types (branched from master)

Event Timeline

More fixes, params and properties too

dereckson retitled this revision from Improve return types doc to Improve documentation and code types coherence .
dereckson edited the summary of this revision. (Show Details)
dereckson edited the test plan for this revision. (Show Details)
dereckson edited the summary of this revision. (Show Details)
dereckson added a reviewer: dereckson.
This revision is now accepted and ready to land.Dec 27 2016, 20:48
This revision was automatically updated to reflect the committed changes.