Update Effective Dart Design Guidelines to Reflect Dart 3.0 Class Modifiers #6449
+532
−55
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
1. Renamed the variable json to data throughout the section. 2. Updated the text to clarify that the example works with deserialized data (e.g., parsed from JSON) rather than raw JSON strings. 3. Ensured consistency in variable naming and explanations. This update makes the documentation more accurate and avoids misleading readers into thinking that the variable holds a JSON string. If you’re contributing to the Dart documentation, you can submit this change as a pull request to the [site-www repository](https://github.com/dart-lang/site-www)
Update the 'Classes and mixins' section to reflect Dart 3.0’s class modifier features:
- Revise API maintainer guidelines to recommend inal, �ase, etc., over documentation for controlling class extension and implementation.
- Remove obsolete user guidelines ('AVOID extending/implementing') as compiler enforcement via modifiers replaces the need for these.
- Add a note explaining the shift and obsoletion, placed at the section’s start for context.
This aligns the guidelines with modern Dart language capabilities, reducing reliance on docs.
1 task
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.
This PR updates the Effective Dart Design Guidelines to align with Dart 3.0's introduction of class modifiers. The changes include:
For API Maintainers:
Removed the recommendation to document whether a class supports being extended or used as an interface.
Added guidance to use class modifiers (e.g., final, sealed, interface, mixin) to explicitly define a class's capabilities.
Emphasized that class modifiers should replace manual documentation for enforcing restrictions on extending or implementing classes.
For Users:
Removed guidelines advising users to avoid extending or implementing classes not meant for it, as these restrictions are now enforced by class modifiers in Dart 3.0.
This change ensures the guidelines are up-to-date with Dart's latest features and best practices.