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.

Sign up for GitHub

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

Jump to bottom

Update content in 'Concurrency in Dart' page #3720

Closed
4 of 8 tasks
kwalrath opened this issue Dec 9, 2021 · 0 comments · Fixed by #5332 or #5402
Closed
4 of 8 tasks

Update content in 'Concurrency in Dart' page #3720

kwalrath opened this issue Dec 9, 2021 · 0 comments · Fixed by #5332 or #5402
Labels
a.language Relates to the Dart language tour e1-hours Can complete in < 8 hours of normal, not dedicated, work e2-days Can complete in < 5 days of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged test.general Relates to unit, integration, perf testing

Comments

@kwalrath
Copy link
Contributor

kwalrath commented Dec 9, 2021 •
edited by atsansone
Loading

Page URL

https://dart.dev/language/concurrency

Page source

https://github.com/dart-lang/site-www/tree/master/src/_guides/language/concurrency/index.md

Describe the problem

Definitely:

  • Convert code snippets to use code excerpts. (@parlough)
  • Add this page to the sidenav. Link to it appropriately. (Add concurrency to the sidenav #3850)
  • Figure out how to save an editable version of the source that has the right fonts.

Maybe:

  • Change diagrams to mention port/ReceivePort/SendPort.
  • Add a figure (or code?) high up in the doc to make it more inviting, and to make clear that it isn't just words.
  • Give more information about performance, perhaps in its own page. New page: Concurrency in Dart #3696 (comment) has some details. So does the 2.15 blog post.
  • Add a new macro & style for "Flutter note:" asides?
  • Add a something to the page (and/or a FAQ entry) with the term single-threaded language. It might also say Dart code executes in a predictable sequence that can’t be interrupted by other Dart code.

Expected fix

No response

Additional context

Followup to #3696.
@kwalrath kwalrath mentioned this issue Dec 9, 2021
Merged
@parlough parlough added docs e1-hours Can complete in < 8 hours of normal, not dedicated, work e2-days Can complete in < 5 days of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. test.general Relates to unit, integration, perf testing labels Dec 10, 2021
@snyk-bot snyk-bot mentioned this issue Feb 2, 2022
Open
parlough added a commit that referenced this issue Jul 10, 2022
@parlough
Add flutter-note site shortcut
5286846 
Makes progress towards #3720
@parlough parlough mentioned this issue Jul 10, 2022
Merged
parlough added a commit that referenced this issue Jul 10, 2022
@parlough
Add flutter-note site shortcut (#4134)
f9c1d98 
Makes progress towards #3720
@atsansone atsansone added a.language Relates to the Dart language tour st.triage.ltw Indicates Lead Tech Writer has triaged and removed docs labels Apr 17, 2023
@atsansone atsansone changed the title [PAGE ISSUE]: Post-publishing work for 'Concurrency in Dart' Update content in 'Concurrency in Dart' page Apr 17, 2023
@ericwindmill ericwindmill mentioned this issue Nov 9, 2023
Merged
@ericwindmill ericwindmill mentioned this issue Dec 11, 2023
Merged
4 tasks
ericwindmill added a commit that referenced this issue Dec 14, 2023
@ericwindmill @MaryaBelanger @parlough
Concurrency overview page update (#5402)
0948944 
This is the first PR of two that will update isolate documentation. It
was decided that we should split [the original
PR](#5332) into two.

This PR updates documentation at language/concurrency with more
information.

Fixes #3720

---

- [x] I’ve reviewed the contributor guide and applied the relevant
portions to this PR.
- [x] This PR doesn’t contain automatically generated corrections or
text (Grammarly, LLMs, and similar).
- [x] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [x] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.

---------

Co-authored-by: Marya <111139605+MaryaBelanger@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
ericwindmill added a commit that referenced this issue Jan 4, 2024
@ericwindmill @parlough @MaryaBelanger
Isolate examples documentation (#5332)
87996d7 
This PR is being split into two. The first one can be found
[here](#5402).

This PR updates documentation at language/concurrency with more
information, and adds a page language/isolates with examples.

Fixes #3720

**Staged:**

-
[Concurrency](https://dart-dev--pr5332-isolate-documentatio-gmqcme0e.web.app/language/concurrency)
_(Updated)_
-
[Isolates](https://dart-dev--pr5332-isolate-documentatio-gmqcme0e.web.app/language/isolates)
_(New)_

---------

Co-authored-by: Parker Lougheed <parlough@gmail.com>
Co-authored-by: Marya <111139605+MaryaBelanger@users.noreply.github.com>
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@ericwindmill @MaryaBelanger
@parlough @atsansone
Concurrency overview page update (dart-lang#5402)
ee2f864 
This is the first PR of two that will update isolate documentation. It
was decided that we should split [the original
PR](dart-lang#5332) into two.

This PR updates documentation at language/concurrency with more
information.

Fixes dart-lang#3720

---

- [x] I’ve reviewed the contributor guide and applied the relevant
portions to this PR.
- [x] This PR doesn’t contain automatically generated corrections or
text (Grammarly, LLMs, and similar).
- [x] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [x] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.

---------

Co-authored-by: Marya <111139605+MaryaBelanger@users.noreply.github.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@ericwindmill @parlough
@MaryaBelanger @atsansone
Isolate examples documentation (dart-lang#5332)
5dc5329 
This PR is being split into two. The first one can be found
[here](dart-lang#5402).

This PR updates documentation at language/concurrency with more
information, and adds a page language/isolates with examples.

Fixes dart-lang#3720

**Staged:**

-
[Concurrency](https://dart-dev--pr5332-isolate-documentatio-gmqcme0e.web.app/language/concurrency)
_(Updated)_
-
[Isolates](https://dart-dev--pr5332-isolate-documentatio-gmqcme0e.web.app/language/isolates)
_(New)_

---------

Co-authored-by: Parker Lougheed <parlough@gmail.com>
Co-authored-by: Marya <111139605+MaryaBelanger@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
a.language Relates to the Dart language tour e1-hours Can complete in < 8 hours of normal, not dedicated, work e2-days Can complete in < 5 days of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged test.general Relates to unit, integration, perf testing
Projects
None yet
Milestone
No milestone
3 participants
@atsansone @kwalrath @parlough