Skip to content

Added a basic example #583

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

Closed
wants to merge 8 commits into from
Closed

Added a basic example #583

wants to merge 8 commits into from

Conversation

yashints
Copy link
Contributor

@yashints yashints commented Oct 4, 2018

Summary

Added a basic example of the usage

Fixes dotnet/docs#6272

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@dnfclas
Copy link

dnfclas commented Oct 4, 2018

CLA assistant check
All CLA requirements met.

@mairaw mairaw requested a review from BillWagner October 22, 2018 19:24
Added a more practical example
updated the description to make it clear it will get run on the same thread
@BillWagner BillWagner requested a review from rpetrusha October 31, 2018 15:28
Added an example of a wrong use case and an example of a unit test using it
@yashints
Copy link
Contributor Author

@BillWagner could you review the changes now? included a wrong use case and a unit test as you mentioned

@BillWagner
Copy link
Member

I've been remiss in commenting on this PR; I apologize for that.

The delay is that I'm struggling with the right recommendation to update it. In general, we try to write positive guidance rather than negative guidance. There's two reasons:

  1. A reader seeing "don't do this" asks the obvious question "what should I do instead?"
  2. APIs are created for a reason. Our role with docs is to identify those scenarios where an API should be used (and direct readers to alternatives when they land at the wrong solution).

I'm checking with the team to get recommendations.

@BillWagner
Copy link
Member

After a lot of debate, I'm closing this.

The API reference is the wrong location for conceptual guidance, which is what this PR does. That means developers find this only when they've already reach the point where they are searching for a specific method.

A better way to provide this guidance is to create an article in our conceptual section that provides the correct way to ensure that a GUI remains responsive during long-running tasks.

Consider this type of guidance as part fo dotnet/docs#6373 or dotnet/docs#951

@BillWagner BillWagner closed this Apr 10, 2019
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.

None yet

4 participants