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

Some examples for the Async module. #12477

Merged
merged 4 commits into from
Sep 24, 2022

Conversation

JustinWick
Copy link
Contributor

@JustinWick JustinWick commented Dec 1, 2021

In accordance with #12124, I've added examples to many Async module functions.

As asynchronicity is the entire point of the module, these examples highlight the timing and order of operations when using the provided functions, often with an intentional degree of explicit nondeterminism inside the computations themselves.

Upon review I'm not sure exactly how useful some of these examples will be, but most of them would have helped me when I was learning how to use these functions. I won't be offended if we have to go in a different direction.

If you want to see these in action, I have a quick-and-dirty standalone examples project here that I'm going to leave up for a while:
https://github.com/JustinWick/FSharpExamples

Note: I am not an expert FSharp programmer, so I wouldn't be surprised if there are some small formatting issues here.

@dnfadmin
Copy link

dnfadmin commented Dec 1, 2021

CLA assistant check
All CLA requirements met.

Copy link
Contributor

@dsyme dsyme left a comment

Choose a reason for hiding this comment

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

These are great! I've left a few comments, only a few relatively minor changes are needed, thank you

src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
src/fsharp/FSharp.Core/async.fsi Outdated Show resolved Hide resolved
@KevinRansom KevinRansom reopened this Mar 11, 2022
@KevinRansom
Copy link
Member

KevinRansom commented Jun 13, 2022

@JustinWick thank you for creating this contribution, it has been 6 months since any comment or contribution has been made, please reopen if you decide you wish to pursue it.

Kevin

@JustinWick
Copy link
Contributor Author

@JustinWick thank you for creating this contribution, it has been 6 months since any comment or contribution has been made, please reopen if you decide you wish to pursue it.

Kevin

Apologies all, it's been a hell of a last year, but the insanity is finally over.

I don't know if we still need examples, but I'm happy to make those last few pushes to get the goal lines over if we do.

I don't seem to be able to re-open this.

@dsyme dsyme reopened this Aug 17, 2022
@dsyme
Copy link
Contributor

dsyme commented Aug 17, 2022

@JustinWick I've reopened - yes, I believe we still need the examples :)) Thanks!

@dsyme dsyme force-pushed the FSharpControlAsyncAddDocExamples branch from cf3603c to f16b7e1 Compare September 23, 2022 19:04
@dsyme
Copy link
Contributor

dsyme commented Sep 23, 2022

@JustinWick I've updated this to main

@dsyme
Copy link
Contributor

dsyme commented Sep 23, 2022

I did some updates, this is ready once green

@dsyme dsyme enabled auto-merge (squash) September 23, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants