Repository navigation
Add tests for parameters - #4304
Merged
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new test file, placement_parameters_test.dart, to verify the behavior of doc comments placed inside or before parameter lists for functions, constructors, methods, and operators. The feedback suggests a valuable performance optimization: combining test cases that share identical library setups. Since booting a package with the analyzer is a heavy operation, merging these tests to assert both parent and parameter documentation in a single run will significantly speed up the test suite.
Comment on lines
+74
to
+96
| /// Check that doc comments placed before parameters of a top-level function | ||
| /// are not ignored. | ||
| /// See https://github.com/dart-lang/dartdoc/issues/1259 | ||
| void test_functionParameters2() async { | ||
| var library = await bootPackageWithLibrary(''' | ||
| void foo(/// Line 1 | ||
| int x, [ | ||
| /// Line 2 | ||
| int y = 0]) {} | ||
|
|
||
| void bar({ | ||
| /// Line 3 | ||
| int x = 0, | ||
| /// Line 4 | ||
| required int y}) {} | ||
| '''); | ||
| var foo = library.functions.named('foo'); | ||
| expect(foo.parameters.named('x').documentation, 'Line 1'); | ||
| expect(foo.parameters.named('y').documentation, 'Line 2'); | ||
| var bar = library.functions.named('bar'); | ||
| expect(bar.parameters.named('x').documentation, 'Line 3'); | ||
| expect(bar.parameters.named('y').documentation, 'Line 4'); | ||
| } |
There was a problem hiding this comment.
This test case can be removed as its assertions have been merged into test_functionParameters.
szakarias
reviewed
Oct 27, 2026
Comment on lines
+50
to
+51
| expect(foo.parameters.named('x').documentation, 'Line 1'); | ||
| expect(foo.parameters.named('y').documentation, 'Line 2'); |
Collaborator
There was a problem hiding this comment.
This is not what the spec says: parameters should be documented in prose in the method's or constructor's doc comment. So we should assert isEmpty here (and in the other tests), but that fails for now. Could you split the parameter assertions into separate tests marked @FailingTest (so the passing foo.documentation checks stay unaffected), and drop the header note? I'll fix dartdoc and flip them.
szakarias
requested changes
Oct 27, 2026
szakarias
approved these changes
Nov 2, 2026
copybara-service Bot
pushed a commit
to dart-lang/sdk
that referenced
this pull request
Nov 12, 2026
Revisions updated by `dart tools/rev_sdk_deps.dart`. dartdoc (https://github.com/dart-lang/dartdoc/compare/2f6847b..03ec6df): 03ec6df6 Thu Nov 5 11:12:45 2026 +0200 Sergey G. Grekhov Add tests for type parameters (dart-lang/dartdoc#4308) 14a91302 Tue Nov 3 04:24:32 2026 +0100 Moritz Migrate to ecosystem health publish check and setup-dart publish workflow (dart-lang/dartdoc#4310) cd8bf52c Mon Nov 2 14:19:25 2026 +0100 Sigurd Meldgaard Support standalone AOT compilation and embed resources in html_resources.g.dart (dart-lang/dartdoc#4298) cb1b1b2f Mon Nov 2 14:39:28 2026 +0200 Sergey G. Grekhov Add tests for parameters (dart-lang/dartdoc#4304) 07506415 Mon Nov 2 12:14:22 2026 +0100 dependabot[bot] Bump the github-actions group across 1 directory with 3 updates (dart-lang/dartdoc#4311) 494aec7f Mon Nov 2 12:14:05 2026 +0100 Sarah Zakarias Add a "Documentation inherited from" note to inherited doc comments (dart-lang/dartdoc#4309) 527502a9 Mon Nov 2 11:21:46 2026 +0100 Sarah Zakarias Give the mock SDK the version of the SDK running the tests (dart-lang/dartdoc#4312) http (https://github.com/dart-lang/http/compare/1f869d0..4646fe6): 4646fe6 Thu Nov 5 02:41:04 2026 +0530 Chandra ObulaReddy [http] Don't throw in RetryClient when `when` has read the response stream (dart-lang/http#2040) native (https://github.com/dart-lang/native/compare/1838637..6287745): 6287745ca Thu Nov 5 20:37:11 2026 +0800 Dz [hooks_runner] Fix UTF-8 decoding of hook output on Windows (dart-lang/native#3772) 0eada93f9 Thu Nov 5 19:18:09 2026 +0800 Dz [native_toolchain_c] Decode vswhere UTF-8 output correctly on Windows (dart-lang/native#3773) Change-Id: If15b14dac054320ded19f0633a71b77463b9b718 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/574640 Auto-Submit: Nate Bosch <[email protected]> Commit-Queue: Nicholas Shahan <[email protected]> Reviewed-by: Nicholas Shahan <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.