Paths

Table of Contentst

Differential D25799

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

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

Details

Reviewers

valerio.bozzolan

Group Reviewers

O1: Blessed Committers

Maniphest Tasks

T15923: Make all PHPDoc @param have variable names

Commits

rARC05abd055019c: Promote 2024.35 to stable
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.Aug 23 2024, 10:56

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

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

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

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

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

This revision is now accepted and ready to land.Aug 23 2024, 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. :)

Add missing variable names to PHPDoc @param of methodsClosedPublicActions

Details

Diff Detail

Unit TestsFailedView All

Event Timeline

Large Diff

Revision ContentsChangeset List

Diff 2414

src/channel/PhutilChannel.php

src/channel/PhutilExecChannel.php

src/channel/PhutilProtocolChannel.php

src/channel/PhutilSocketChannel.php

src/conduit/ConduitClient.php

src/configuration/ArcanistConfigurationManager.php

src/console/PhutilConsole.php

src/console/PhutilInteractiveEditor.php

src/console/format.php

src/console/view/PhutilConsoleTable.php

src/console/view/PhutilConsoleView.php

src/differential/ArcanistDifferentialCommitMessage.php

src/error/PhutilErrorHandler.php

src/error/phlog.php

src/filesystem/FileFinder.php

src/filesystem/FileList.php

src/filesystem/Filesystem.php

src/filesystem/FilesystemException.php

src/filesystem/PhutilDeferredLog.php

src/filesystem/PhutilFileLock.php

src/filesystem/PhutilLock.php

src/filesystem/TempFile.php

src/filesystem/linesofalarge/LinesOfALarge.php

src/filesystem/linesofalarge/LinesOfALargeExecFuture.php

src/filesystem/linesofalarge/LinesOfALargeFile.php

src/future/FutureIterator.php

src/future/exec/ExecFuture.php

src/future/exec/PhutilExecutableFuture.php

src/future/exec/execx.php

src/future/http/BaseHTTPFuture.php

src/future/http/HTTPSFuture.php

src/hgdaemon/ArcanistHgClientChannel.php

src/hgdaemon/ArcanistHgProxyClient.php

src/hgdaemon/ArcanistHgProxyServer.php

src/hgdaemon/ArcanistHgServerChannel.php

src/init/lib/PhutilLibraryConflictException.php

src/internationalization/PhutilLocale.php

src/internationalization/PhutilTranslation.php

src/internationalization/PhutilTranslator.php

src/internationalization/pht.php

src/land/engine/ArcanistLandEngine.php

src/lexer/PhutilLexer.php

src/lexer/PhutilShellLexer.php

src/lint/ArcanistLintMessage.php

src/lint/engine/ArcanistLintEngine.php

src/lint/linter/ArcanistBaseXHPASTLinter.php

src/lint/linter/ArcanistChmodLinter.php

src/lint/linter/ArcanistExternalLinter.php

src/lint/linter/ArcanistFutureLinter.php

src/lint/linter/ArcanistLinter.php

src/lint/linter/ArcanistScriptAndRegexLinter.php

src/lint/linter/ArcanistXHPASTLinter.php

src/lint/linter/__tests__/ArcanistLinterTestCase.php

src/lint/linter/standards/ArcanistLinterStandard.php

src/lint/linter/xhpast/ArcanistXHPASTLintNamingHook.php

src/lint/linter/xhpast/ArcanistXHPASTLinterRule.php

src/moduleutils/PhutilLibraryMapBuilder.php

src/object/Phobject.php

src/parser/ArcanistDiffParser.php

src/parser/PhutilEditorConfig.php

src/parser/PhutilJSON.php

src/parser/PhutilLanguageGuesser.php

src/parser/PhutilQueryStringParser.php

src/parser/PhutilSimpleOptions.php

src/parser/aast/api/AASTNode.php

src/parser/argument/PhutilArgumentParser.php

src/parser/argument/PhutilArgumentSpecification.php

src/parser/xhpast/api/XHPASTNode.php

src/parser/xhpast/api/__tests__/XHPASTNodeTestCase.php

src/parser/xhpast/bin/PhutilXHPASTBinary.php

src/readableserializer/PhutilReadableSerializer.php

src/repository/api/ArcanistGitAPI.php

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

Unit TestsFailed
View All

Revision Contents
Changeset List

src/lint/linter/tests/ArcanistLinterTestCase.php

src/parser/xhpast/api/tests/XHPASTNodeTestCase.php