Skip to content

Commit 58ddf4d

Browse files
authored
Use = to document default values for named parameters - Fixes #2087 (#2453)
* Uses = instead of : to display assignment of default named parameters - Fixes #2087 * Update required parameter test case
1 parent 6d042f5 commit 58ddf4d

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

lib/src/render/parameter_renderer.dart

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,7 @@ abstract class ParameterRenderer {
208208
}
209209

210210
if (param.hasDefaultValue) {
211-
if (param.isNamed) {
212-
buf.write(': ');
213-
} else {
214-
buf.write(' = ');
215-
}
211+
buf.write(' = ');
216212
buf.write(defaultValue(param.defaultValue));
217213
}
218214
return buf.toString();

test/end2end/model_special_cases_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ void main() {
127127
'<li><span class="parameter" id="m1-param-regular"><span class="type-annotation">dynamic</span> <span class="parameter-name">regular</span>, </span></li>\n'
128128
'<li><span class="parameter" id="m1-param-parameters"><span>covariant</span> <span class="type-annotation">dynamic</span> <span class="parameter-name">parameters</span>, </span></li>\n'
129129
'<li><span class="parameter" id="m1-param-p1">{<span>required</span> <span class="type-annotation">dynamic</span> <span class="parameter-name">p1</span>, </span></li>\n'
130-
'<li><span class="parameter" id="m1-param-p2"><span class="type-annotation">int</span> <span class="parameter-name">p2</span>: <span class="default-value">3</span>, </span></li>\n'
130+
'<li><span class="parameter" id="m1-param-p2"><span class="type-annotation">int</span> <span class="parameter-name">p2</span> = <span class="default-value">3</span>, </span></li>\n'
131131
'<li><span class="parameter" id="m1-param-p3"><span>required</span> <span>covariant</span> <span class="type-annotation">dynamic</span> <span class="parameter-name">p3</span>, </span></li>\n'
132132
'<li><span class="parameter" id="m1-param-p4"><span>required</span> <span>covariant</span> <span class="type-annotation">int</span> <span class="parameter-name">p4</span>}</span></li>\n'
133133
'</ol>'));

test/end2end/model_test.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3601,6 +3601,12 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
36013601
expect(intCheckOptional.isNamed, isTrue);
36023602
});
36033603

3604+
test('uses = instead of : to set default value', () {
3605+
final rendered =
3606+
ParameterRendererHtml().renderLinkedParams([intCheckOptional]);
3607+
expect(rendered.contains('</span> = <span'), isTrue);
3608+
});
3609+
36043610
test('linkedName', () {
36053611
expect(intCheckOptional.modelType.linkedName, 'int');
36063612
});

0 commit comments

Comments
 (0)