Add missing variable names to PHPDoc @param of methods
ClosedPublic
Actions

Authored by aklapper on Fri, Aug 23, 10:56.

Details

Reviewers

valerio.bozzolan

Group Reviewers

O1: Blessed Committers

Maniphest Tasks

T15923: Make all PHPDoc @param have variable names

Commits

rARC04e3e250f7da: Add missing variable names to PHPDoc @param of methods

Summary

Add variable names ($varname in @param type $varname explanation) to PHPDoc method headers, for fun and profit.

Closes T15923

Test Plan

Read the method signatures and their corresponding PHPDoc headers at your fireplace
Still run ./bin/diviner generate without explosions (though it is very lenient anyway?)

Diff Detail

Repository

rARC Arcanist

Branch

phpDocParamVarnames

Lint

Lint Passed

Unit

Test Failures

Build Status

Buildable 1558
Build 1558: arc lint + arc unit

Unit TestsFailed
View All

	Time	Test
	687 ms	ArcanistBundleTestCase::testGitRepository EXCEPTION (Exception): Expected patch and actual patch for 5dec8bf28557f078d1987c4e8cfb53d08310f522 differ. Wrote actual patch to '/var/www/html/phorge/arcanist/src/parser/__tests__/patches//5dec8bf28557f078d1987c4e8cfb53d08310f522.gitpatch.real'. #0 /var/www/html/phorge/arcanist/src/parser/__tests__/ArcanistBundleTestCase.php(85): ArcanistBundleTestCase->runGitRepositoryTests(Object(PhutilDirectoryFixture)) #1 /var/www/html/phorge/arcanist/src/unit/engine/phutil/PhutilTestCase.php(639): ArcanistBundleTestCase->testGitRepository()
	97 ms	ArcanistXMLLinterTestCase::testLinter Lint emitted an unexpected set of messages for file "languages-6.lint-test". MISSING MESSAGES Message with severity "error" at "4:1" (XML5)
	78 ms	AbstractDirectedGraphTestCase::testCyclicGraph 1 assertion(s) passed.
	91 ms	AbstractDirectedGraphTestCase::testEdgeLoadFailure 1 assertion(s) passed.
	79 ms	AbstractDirectedGraphTestCase::testNonTreeGraph 1 assertion(s) passed.
		View Full Test Results (2 Failed · 344 Passed · 32 Skipped)

Event Timeline

aklapper created this revision.Fri, Aug 23, 10:56

Owners added a reviewer: O1: Blessed Committers.Fri, Aug 23, 10:56

Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan, tobiaswiese. · View Herald TranscriptFri, Aug 23, 10:56

aklapper requested review of this revision.Fri, Aug 23, 10:56

Harbormaster completed remote builds in B1558: Diff 2414.Fri, Aug 23, 10:56

Wojak depressed.png (473×635 px, 160 KB)

This revision is now accepted and ready to land.Fri, Aug 23, 13:32

FYI T15927: Fix Arcanist unit test ArcanistBundleTestCase->testNonlocalTrailingNewline() on non-English terminal

@valerio.bozzolan Thanks, this unblocks a few more things on my list. I admit that I have not looked into the unit test failure here and I assume you understand it and that it is fine to merge this patch. :)

This revision was landed with ongoing or failed builds.Fri, Aug 23, 16:52

Closed by commit rARC04e3e250f7da: Add missing variable names to PHPDoc @param of methods. · Explain Why

This revision was automatically updated to reflect the committed changes.

aklapper added a commit: rARC04e3e250f7da: Add missing variable names to PHPDoc @param of methods.