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

Update and improve or replace the zones page #4348

Open
11 tasks
parlough opened this issue Nov 7, 2022 · 0 comments
Open
11 tasks

Update and improve or replace the zones page #4348

parlough opened this issue Nov 7, 2022 · 0 comments
Labels
e2-days Can complete in < 5 days of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

parlough commented Nov 7, 2022

Page URL: https://dart.dev/articles/archive/zones

Page source: https://github.com/dart-lang/site-www/tree/main/src/_articles/archive/zones.md

The Dart Zones page is the only document covering zones but it is out of date, has issues, and is not following the website's current documentation and writing guidelines. We should update or completely replace it.

Some issues that the current page has for reference:

  • Code does not follow Dart 2 standards, formatting, or suggested linter rules
  • Some code/explanations are now incorrect
  • Code is not tested
  • Writing and structure does not match current site standards
  • "A zone represents the asynchronous dynamic extent of a call" section is too technical and doesn't explain vocabulary ('Zones' page issue #2147)
  • "Child zones don’t completely replace their parent zone" is not clear enough about what is replaced and what isn't ('Zones' page issue #2149)
  • "A simple rule determines where errors are handled in a sequence" does not explain what the simple rule is ('Zones' page issue #2150)
  • "the original zone must be the one that executes the microtask" has no explanation of why ('Zones' page issue #2151)
  • "The run parameter also works for the initial, synchronous code that executes just after calling runZoned()." doesn't explain what the synchronous code is ('Zones' page issue #2153)
  • runZoned will no longer have an onError parameter and must use runZoneGuarded ([2.19] runZoned docs #4224)
  • Error zones may be removed from zones (Remove "error zones" from Zone. sdk#49457)
@parlough parlough added p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e2-days Can complete in < 5 days of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content labels Nov 7, 2022
@parlough parlough changed the title Update and improve the zones page Update and improve or replace the zones page Nov 7, 2022
atsansone added a commit that referenced this issue Dec 20, 2022
This page obviously needs a lot of work, so I didn't update any of the
conceptual content or any other dart syntax stuff _except_ what is
directly related to changing the examples to using `runZonedGuarded`.

Full page update is tracked here:
#4348

Closes #4224

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
parlough added a commit that referenced this issue Jan 23, 2023
This page obviously needs a lot of work, so I didn't update any of the
conceptual content or any other dart syntax stuff _except_ what is
directly related to changing the examples to using `runZonedGuarded`.

Full page update is tracked here:
#4348

Closes #4224

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
parlough added a commit that referenced this issue Jan 23, 2023
This page obviously needs a lot of work, so I didn't update any of the
conceptual content or any other dart syntax stuff _except_ what is
directly related to changing the examples to using `runZonedGuarded`.

Full page update is tracked here:
#4348

Closes #4224

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
parlough added a commit that referenced this issue Jan 24, 2023
This page obviously needs a lot of work, so I didn't update any of the
conceptual content or any other dart syntax stuff _except_ what is
directly related to changing the examples to using `runZonedGuarded`.

Full page update is tracked here:
#4348

Closes #4224

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
parlough added a commit that referenced this issue Jan 24, 2023
This page obviously needs a lot of work, so I didn't update any of the
conceptual content or any other dart syntax stuff _except_ what is
directly related to changing the examples to using `runZonedGuarded`.

Full page update is tracked here:
#4348

Closes #4224

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e2-days Can complete in < 5 days of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

2 participants