Skip to content

Some doc issues in the reopen documentation #51270

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

Closed
srawlins opened this issue Feb 6, 2023 · 5 comments
Closed

Some doc issues in the reopen documentation #51270

srawlins opened this issue Feb 6, 2023 · 5 comments
Assignees
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. devexp-pkg-meta Issues related to package:meta type-documentation A request to add or improve documentation
Milestone

Comments

@srawlins
Copy link
Member

srawlins commented Feb 6, 2023

  • "Indicates that the annotated class or mixin declaration intentionally allows subclasses to implement or extend it," - This should also say, "or mix it in", correct?
  • "if it's marked interface, or if it is marked sealed and" - 'interface' and 'sealed' must be enclosed in backticks
  • "A class or mixin prevents inheritance" - This language is confusing to me, or maybe non-idiomatic. I don't think classes prevent this or that. The spec uses the word "prevent" to indicate that the language prevents such-and-such or a developer may want to prevent this or that. Also, "inheritance" is not found in the spec. What does it mean? A class which "prevents inheritance" cannot be extended? implemented? mixed in? all three?
  • "and the subclass is marked base," - 'base' must be enclosed in backticks.
  • "it extends or mixes in another class or mixin which requires inheritance." - What does "requires inheritance" mean?
  • "or has as an on type" - this seems hard to read. Should 'on' just be in quotes? backticks?

CC @pq @lrhn

@srawlins srawlins added area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. type-documentation A request to add or improve documentation devexp-pkg-meta Issues related to package:meta labels Feb 6, 2023
@srawlins srawlins added this to the Dart 3 beta 3 milestone Feb 24, 2023
@pq
Copy link
Member

pq commented Mar 2, 2023

See also: #51551

@itsjustkevin
Copy link
Contributor

FYI: @MaryaBelanger

@MaryaBelanger
Copy link
Contributor

I think this was addressed here 4c7e878 (https://dart-review.googlesource.com/c/sdk/+/286860)? Or are these issues on-top-of/in-spite-of those changes?

@pq
Copy link
Member

pq commented Mar 21, 2023

I think these specific issues were addressed. Let's open new issues for any follow-ups.

(@srawlins: please reopen -- heh -- if you feel otherwise!)

@pq pq closed this as completed Mar 21, 2023
@srawlins
Copy link
Member Author

Looks great! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. devexp-pkg-meta Issues related to package:meta type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

4 participants