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

Overhaul and introduce new type system documentation #4745

Open
parlough opened this issue Apr 6, 2023 · 0 comments
Open

Overhaul and introduce new type system documentation #4745

parlough opened this issue Apr 6, 2023 · 0 comments
Labels
a.language Relates to the Dart language tour dev.type-system Relates to the type system in Dart e3-weeks Complete in < 4 weeks of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content from.team Reported by Dash docs team member p1-high Major but not urgent concern: Resolve in months. Update each month. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

parlough commented Apr 6, 2023

Currently our type system docs are old and limited in scope.

We need to introduce new type system, type inference, and similar documentation, considering the state of the type system with null safety. These docs can potentially be included under Language > Types or a separate reference location. Some of these details can be gathered from Understanding null safety but that doesn't cover everything, it is written for readers transitioning from a pre null-safety world, and is perhaps too detailed for most users. We will need to find a balance.

This is related to #4603.

Edit: Much of this may belong in our reference style documentation (#4783).

@parlough parlough added a.language Relates to the Dart language tour p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. docs e3-weeks Complete in < 4 weeks of normal, not dedicated, work dev.type-system Relates to the type system in Dart labels Apr 6, 2023
@atsansone atsansone added fix.refactor Needs near total rewrite or reorganization of content st.triage.ltw Indicates Lead Tech Writer has triaged and removed docs labels May 3, 2023
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
@atsansone atsansone added p1-high Major but not urgent concern: Resolve in months. Update each month. and removed p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. labels May 15, 2024
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 dev.type-system Relates to the type system in Dart e3-weeks Complete in < 4 weeks of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content from.team Reported by Dash docs team member p1-high Major but not urgent concern: Resolve in months. Update each month. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

2 participants