Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it "initializing parameters" or "initializing formals"? #4011

Closed
mmcdon20 opened this issue Apr 29, 2022 · 3 comments · Fixed by #4012
Closed

Is it "initializing parameters" or "initializing formals"? #4011

mmcdon20 opened this issue Apr 29, 2022 · 3 comments · Fixed by #4012
Labels
a.language Relates to the Dart language tour e0-minutes Can complete in < 60 minutes of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible.

Comments

@mmcdon20
Copy link

Page URL

https://dart.dev/guides/language/language-tour#initializing-parameters

Page source

No response

Describe the problem

The dart language tour describes a feature it calls "initializing parameters", however both effective dart and the dart lint tool documentation refer to the same feature as "initializing formals".

Expected fix

Use a consistent name for this language feature.

Additional context

No response

@parlough parlough added a.language Relates to the Dart language tour p2-medium Necessary but not urgent concern. Resolve when possible. e0-minutes Can complete in < 60 minutes of normal, not dedicated, work labels Apr 29, 2022
@parlough
Copy link
Member

I struggled deciding between these terms but chose simply parameters since I thought it would be the more familiar term for those reading the language tour.

I suppose it is better to be consistent with formals though and better explain the terminology (either here or in another section). Thanks for your thoughts!

@mmcdon20
Copy link
Author

@parlough I do agree that the term "parameters" is far more familiar to people than "formals" is, but "initializing formals" seems to be used everywhere except for the language tour. I did notice that the dart language spec actually uses "initializing formal parameter" a few times, but mostly uses the shortened "initializing formal". I think if you used "initializing formal parameter" in the language tour it might be more approachable to dart newcomers but also not as confusing when you see the feature referred to as "initializing formals" in other dart documentation.

@parlough
Copy link
Member

Yep, I think "Initializing formal parameters" is a good choice since it will be more discoverable when users search or use the TOC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.language Relates to the Dart language tour e0-minutes Can complete in < 60 minutes of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants