Conversation
Summary of ChangesHello @sfshaza2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the project's documentation by introducing a new glossary term. The addition aims to clarify the concept of "Primary constructor," specifically highlighting its application within Dart's extension types, thereby improving the comprehensibility of related technical documentation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds a definition for 'Primary constructor' to the glossary. The definition is good, but it's slightly outdated as it only mentions extension types. I've suggested an update to include primary constructors for classes, which were introduced in Dart 3.4, and to add a relevant documentation link.
| long_description: |- | ||
| A _primary constructor_ is a concise way to declare a constructor | ||
| directly in the type declaration. | ||
|
|
||
| Currently, this feature is only available for [extension types][]. | ||
| It allows you to define the underlying representation object | ||
| and bind it to a field in one step. | ||
|
|
||
| [extension types]: https://dart.dev/language/extension-types | ||
| related_links: | ||
| - text: "Extension types constructors" | ||
| link: "https://dart.dev/language/extension-types#constructors" | ||
| type: "external" |
There was a problem hiding this comment.
The description for primary constructors is slightly outdated. Since Dart 3.4, primary constructors are also available for classes, not just extension types.
I'd suggest updating the description to include classes and adding a link to the relevant documentation for class-based primary constructors to make the glossary entry more accurate and complete.
long_description: |-
A _primary constructor_ is a concise way to declare a constructor
directly in the type declaration.
Primary constructors can be used with [classes][] and [extension types][].
For classes, they allow you to define fields and initialize them from
constructor parameters in one step. For extension types, they allow you
to define the underlying representation object and bind it to a field.
[classes]: https://dart.dev/language/constructors#primary-constructors
[extension types]: https://dart.dev/language/extension-types
related_links:
- text: "Primary constructors for classes"
link: "https://dart.dev/language/constructors#primary-constructors"
type: "external"
- text: "Extension types constructors"
link: "https://dart.dev/language/extension-types#constructors"
type: "external"There was a problem hiding this comment.
'Dart 3.4' is not accurate, the new, generalized primary constructors feature hasn't yet been released, but it's being implemented and will definitely be released.
|
Visit the preview URL for this PR (updated for commit 885f2ef): https://flutter-docs-prod--pr13033-glossary-primary-constructo-qinhfcxj.web.app |
There was a problem hiding this comment.
Thanks for the heads up!
I'll assume that this glossary entry should describe the primary constructors feature which is about to be released—it doesn't seem particularly useful to have one description of the concept for some weeks, and then updating it substantially to cover the much more general notion of primary constructors that we're about to release.
| A _primary constructor_ is a concise way to declare a constructor | ||
| directly in the type declaration. | ||
|
|
||
| Currently, this feature is only available for [extension types][]. |
There was a problem hiding this comment.
This is inaccurate -- primary constructors can be used for classes, extension types, and enums as well.
eernstg
left a comment
There was a problem hiding this comment.
Added a few comments.
Perhaps we should postpone landing this PR until the new primary constructors feature has been released?
There was a problem hiding this comment.
Thanks for the heads up!
I'll assume that this glossary entry should describe the primary constructors feature which is about to be released—it doesn't seem particularly useful to have one description of the concept for some weeks, and then updating it substantially to cover the much more general notion of primary constructors that we're about to release.
|
|
||
| - term: "Primary constructor" | ||
| short_description: |- | ||
| A constructor declared as part of the type declaration. |
There was a problem hiding this comment.
The phrase 'type declaration' is rather vague. It's often used to designate a type annotation (as in "the variable has a type declaration" when talking about declarations like String s = '';), as well as the meaning which is intended here. It would be nice if we could use a phrase which is more precisely denoting a class declaration, a mixin class declaration, an enum declaration, or an extension type declaration.
Next, a class declaration starts at a keyword (often class, but we can also have final class, sealed class, and the like), and it ends at the final } of the class body (or, with the upcoming enhancements, a semicolon which is the entire class body on its own). This implies that every member declaration is also part of "the type declaration". The new thing is that the primary constructor is part of the header of the class declaration, it's not in the body.
Similarly for mixin class declarations etc.
Perhaps this would work:
| A constructor declared as part of the type declaration. | |
| A constructor declared in the header of a class or a similar type declaration. |
| A constructor declared as part of the type declaration. | ||
| long_description: |- | ||
| A _primary constructor_ is a concise way to declare a constructor | ||
| directly in the type declaration. |
There was a problem hiding this comment.
| directly in the type declaration. | |
| directly in the header of a class, mixin class, enum, or extension type declaration. |
| It allows you to define the underlying representation object | ||
| and bind it to a field in one step. |
There was a problem hiding this comment.
I think it's really great that this glossary entry is so short. It should allow developers to get to know about the concept of a primary constructor. There would be other pages about all the details.
So how do we communicate that the primary constructors of class, mixin class, and enum declarations have a large number of properties in common, and the primary constructors of extension types are different in several ways?
Here is one attempt at saying very little, but still enough to give the reader a relevant hint:
| It allows you to define the underlying representation object | |
| and bind it to a field in one step. | |
| A primary constructor in a class, mixin class, or enum declaration is a concise | |
| way to specify a constructor and a number of instance variables in a single | |
| constructor declaration in the header. | |
| A primary constructor in an extension type declaration allows you to define the | |
| underlying representation variable and its type. |
We can't even really say "in a single declaration" when it comes to extension types, because they don't support declaring the representation variable using a regular instance variable declaration in the first place. There is simply no other way to declare the representation variable (name and type) of an extension type than having a primary constructor.
| long_description: |- | ||
| A _primary constructor_ is a concise way to declare a constructor | ||
| directly in the type declaration. | ||
|
|
||
| Currently, this feature is only available for [extension types][]. | ||
| It allows you to define the underlying representation object | ||
| and bind it to a field in one step. | ||
|
|
||
| [extension types]: https://dart.dev/language/extension-types | ||
| related_links: | ||
| - text: "Extension types constructors" | ||
| link: "https://dart.dev/language/extension-types#constructors" | ||
| type: "external" |
There was a problem hiding this comment.
'Dart 3.4' is not accurate, the new, generalized primary constructors feature hasn't yet been released, but it's being implemented and will definitely be released.
Adds a definition for 'Primary constructor' to the glossary, focusing on its usage in Dart extension types.