Format parameters better #3731
Merged
Format parameters better #3731
Conversation
This file contains 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
srawlins
force-pushed
the
format-parameters
branch
from
6ef7589 to
c91cf90
Compare
kallentu
approved these changes
Mar 22, 2024
| if (trailingComma) suffix += ', '; | ||
| } else { | ||
| suffix += ', '; | ||
| for (var p in namedParams) { |
There was a problem hiding this comment.
Can we make a helper to avoid the duplicate logic of each parameter type?
There was a problem hiding this comment.
Ah I was able to fold more things into _renderParameter, much simpler. Thanks!
| </span> | ||
| \} |
There was a problem hiding this comment.
Where is the opening bracket for all the closing brackets in these tests?
There was a problem hiding this comment.
Good catch; these all moved to where you'd expect, based on where the closing ones moved. Updated the tests.
In a nutshell:
* When there are more than 3 parameters, or any named parameters, use "block
style" (vs "inline style", using CSS terminology).
* In block style, always place a comma after the last parameter.
* In block style, display a `{` or `[` delimiter between required and optional
parameters, to the right of the last required parameter.
* In block style, display a `}` or `]` closing delimiter on the line after the
last optional parameter, just before the closing `)`.
* Do not change inline style.
* Indent soft-wrapped lines. This is not as good as whatever `dart format`
would do when hard-wrapping lines, but at least a wrapped parameter has it's
non-first-line text indented to separate from the surrounding parameter
indentations.
srawlins
force-pushed
the
format-parameters
branch
from
c91cf90 to
53b497f
Compare
copybara-service bot
pushed a commit
to dart-lang/sdk
that referenced
this pull request
Mar 28, 2024
Revisions updated by `dart tools/rev_sdk_deps.dart`. dartdoc (https://github.com/dart-lang/dartdoc/compare/79c1675..bf6080c): bf6080c8 2024-03-27 Sam Rawlins Remove unnecessary EnclosedElement mixin (dart-lang/dartdoc#3736) c5bb9066 2024-03-26 Sam Rawlins Bump to 8.0.8; fix changelog wrapping (dart-lang/dartdoc#3735) 4e096f84 2024-03-26 Sam Rawlins Format parameters better (dart-lang/dartdoc#3731) http (https://github.com/dart-lang/http/compare/7949d6f..280d361): 280d361 2024-03-27 Derek Xu [package:http_profile] Expand README.md (dart-lang/http#1162) 9fddb1c 2024-03-27 Brian Quinlan Fix the connectionInfo getter (dart-lang/http#1163) 9f47439 2024-03-27 Derek Xu [package:http_profile] Make connectionInfo a top-level field of HttpClientRequestProfile (dart-lang/http#1160) Change-Id: Ib50584ef7d7914ab262bb01eeb087e44c34e4dc7 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/360240 Auto-Submit: Devon Carew <devoncarew@google.com> Commit-Queue: Konstantin Shcheglov <scheglov@google.com> Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
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.
Compare:
test()andorElse()now on one lineContribution guidelines:
dart format.Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.