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

[Sound null safety] Language feature docs #4584

Open
MaryaBelanger opened this issue Feb 8, 2023 · 1 comment
Open

[Sound null safety] Language feature docs #4584

MaryaBelanger opened this issue Feb 8, 2023 · 1 comment
Labels
dev.null-safety Relates to transforming or migrating Dart code to sound null safety e2-days Can complete in < 5 days of normal, not dedicated, work from.team Reported by Dash docs team member p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Feb 8, 2023

Evaluation of potential changes due to sound null safety: dart-lang/sdk#49530

Summary

  1. (READY) Mentions of optional/unsound null safety across the site need to be removed. There may be some cases where indiscriminately removing related text would make the content confusing, so evaluate the context for each instance (why did it need to be mentioned before, is a caveat still applicable, etc).

  2. (NEEDS FURTHER EVAL) The pages on null safety (listed under Evaluation) need to be dealt with. Especially /migration-guide, /unsound-null-safety, and /faq will likely be completely removed, but each needs to be evaluated for content that may still be useful to users (don't indiscriminately remove them).

    The likely solution is to create a new page under "Types" about nullable types to include some information, and separate out useful, non-version-qualified content (i.e. "before null safety/Dart 2...." kind of qualifiers) from /null-safety and /understanding-null-safety and either put that info onto new pages, or consolidate with other content. Basically we need to pick apart these pages line by line to keep what's relevant and discard what isn't.

Evaluation:

PRs that already addressed sound null safety pre-2.19:

Pages on null safety:

Other mentions of optional null safety:

Things that need to be added somewhere:

Libraries using per-library language version markers selecting versions less than 2.12 (e.g. // @Dart=2.9 will be disallowed).

Code using an SDK constraint where the min-constraint isn't at least 2.12 (e.g. sdk: ">=2.7.0" will be disallowed and won't resolve).

  • packages / dependency docs, maybe pub tools like upgrade, add, etc.
  • change all to 3.0.0 - <4.0.0
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. docs e2-days Can complete in < 5 days of normal, not dedicated, work dev.null-safety Relates to transforming or migrating Dart code to sound null safety labels Feb 8, 2023
@MaryaBelanger MaryaBelanger self-assigned this Feb 8, 2023
@MaryaBelanger
Copy link
Contributor Author

@atsansone Correct me if I'm wrong but I believe we discussed you taking over this? Just assigned you

@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Apr 12, 2023
@atsansone atsansone removed the docs label Jun 28, 2023
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
@atsansone atsansone removed their assignment Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev.null-safety Relates to transforming or migrating Dart code to sound null safety e2-days Can complete in < 5 days of normal, not dedicated, work from.team Reported by Dash docs team member p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

3 participants