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

Isolate examples documentation #5332

Merged
merged 52 commits into from
Jan 4, 2024
Merged

Isolate examples documentation #5332

merged 52 commits into from
Jan 4, 2024

Conversation

ericwindmill
Copy link
Contributor

@ericwindmill ericwindmill commented Nov 9, 2023

This PR is being split into two. The first one can be found here.

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

Fixes #3720

Staged:

@parlough parlough added the review.tech Awaiting Technical Review label Nov 9, 2023
Copy link

github-actions bot commented Nov 10, 2023

Visit the preview URL for this PR (updated for commit 8c31560):

https://dart-dev--pr5332-isolate-documentatio-wj7iadc7.web.app

(expires Thu, 11 Jan 2024 14:09:23 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: d851bc446d3c4d7394c5406c6f07255afc7075f3

@parlough
Copy link
Member

@parlough Can you help me understand what's going on with the test failures? It looks like it's code excerpt issues, but is there a way to get a verbose output?

It's unfortunately a bit obscure right now. I guess the original thinking was that people would just run the ./tool/refresh-code-excerpts.sh script.

I'm working on finalizing an updated version of the tool that is simpler to run and will provide some more details on what needs to be updated. Until then, let me know if you need me to run the tool.

@MaryaBelanger MaryaBelanger self-assigned this Nov 21, 2023
Copy link
Contributor

@MaryaBelanger MaryaBelanger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not done reviewing yet, but here's what I've got so far!

src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
src/language/concurrency.md Outdated Show resolved Hide resolved
@ericwindmill ericwindmill changed the title Isolate documentation (Don't merge) Isolate examples documentation Jan 2, 2024
@MaryaBelanger
Copy link
Contributor

Not finished reviewing yet, but as part of this PR you should link to this new isolates page somewhere on the Concurrency page. I suggest the end of the first paragraph (and you can fix the typo there too):

For more practical code examples of using async features concurrency in Dart,
read the Asynchrony support page and the Isolates page.

@dart-github-bot
Copy link
Collaborator

dart-github-bot commented Jan 3, 2024

Visit the preview URL for this PR (updated for commit 8c31560):

https://dart-dev--pr5332-isolate-documentation-axfgpc3r.web.app

Copy link
Contributor

@MaryaBelanger MaryaBelanger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PHEW! What a mammoth piece of work, and it turned out so great! Thank you!

Don't forget to get another technical review for your new examples (if you haven't already done so offline :)).

src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
src/language/isolates.md Outdated Show resolved Hide resolved
Co-authored-by: Marya <111139605+MaryaBelanger@users.noreply.github.com>
@ericwindmill
Copy link
Contributor Author

@johnpryan, @lrhn, @domesticmouse, can one of you please review the ports code examples? Most importantly examples/concurrency/lib/robust_ports_example/complete.dart

Copy link
Member

@lrhn lrhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The complete example, and the steps towards it, LGTM!

final ReceivePort _responses;
// #enddocregion constructor
static Future<Worker> spawn() async {
// Create a receive port and add it's initial message handler
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's -> its

@ericwindmill ericwindmill merged commit 87996d7 into main Jan 4, 2024
10 checks passed
@ericwindmill ericwindmill deleted the isolate-documentation branch January 4, 2024 14:12
MaryaBelanger pushed a commit that referenced this pull request Jan 17, 2024
This PR fixes typos introduced in
#5332

---

Co-authored-by: Parker Lougheed <parlough@gmail.com>
atsansone pushed a commit to atsansone/site-www that referenced this pull request Jan 26, 2024
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 pull request Jan 26, 2024
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>
atsansone pushed a commit to atsansone/site-www that referenced this pull request Jan 26, 2024
This PR fixes typos introduced in
dart-lang#5332

---

Co-authored-by: Parker Lougheed <parlough@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review.tech Awaiting Technical Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update content in 'Concurrency in Dart' page
5 participants