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

FutureOr, void, and dynamic docs improvements #3678

Open
jakemac53 opened this issue Feb 23, 2024 · 2 comments
Open

FutureOr, void, and dynamic docs improvements #3678

jakemac53 opened this issue Feb 23, 2024 · 2 comments
Labels
P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@jakemac53
Copy link
Contributor

This may not be worth fixing, but in the API docs FutureOr is listed as being a "class", even though it isn't actually one. It is weird though because in the code, it is listed as an abstract class (with docs saying it really isn't a class). So presumably that is why it shows up as a class in dartdoc. This could be confusing, because there really are differences between just being a type and being a class.

In thinking about any other weird types like this, void and dynamic came to mind. Neither of these have any documentation at all that I can find, because we didn't do the abstract class workaround just to get docs.

It might be worth creating a new category called just "type", which we could use just to document these, with some special casing in dartdoc?

@jakemac53 jakemac53 changed the title FutureOr, void, and dynamic docs improvments FutureOr, void, and dynamic docs improvements Feb 23, 2024
@srawlins
Copy link
Member

Yeah, I'd love to get that all fixed; the main issue is #2391.

We could special case FutureOr though, to indicate it is not a class.

@srawlins srawlins added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P3 A lower priority bug or feature request labels Feb 23, 2024
@jakemac53
Copy link
Contributor Author

SGTM, feel free to close this as a dupe (originally I searched just for FutureOr issues).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 A lower priority bug or feature request type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

2 participants