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

Fix misleading in the Main doc about async/Task #41356

Merged
merged 26 commits into from
Jun 21, 2024

Conversation

vernou
Copy link
Contributor

@vernou vernou commented Jun 10, 2024

Summary

  • Modify the overview list to be more explicit
  • Replace "signature" by "declaration"
  • Replace "valid Main:" by "the most common Main", because the list isn't exhaustive
  • Replace "public accessor modifier. That's typical, but not required." by default accessor, because it sound most common
  • Rework the async/task part

Fixes #40972


Internal previews

📄 File 🔗 Preview link
docs/csharp/fundamentals/program-structure/main-command-line.md Main() and command-line arguments

@vernou vernou requested a review from BillWagner as a code owner June 10, 2024 21:30
@dotnet-bot dotnet-bot added this to the June 2024 milestone Jun 10, 2024
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates PR is created by someone from the .NET community. label Jun 10, 2024
@richlander
Copy link
Member

@stephentoub

Co-authored-by: David Pine <david.pine@microsoft.com>
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

I also added some thoughts on this explanation.

Co-authored-by: Bill Wagner <wiwagn@microsoft.com>
@vernou
Copy link
Contributor Author

vernou commented Jun 11, 2024

@dotnet-policy-service agree

@vernou vernou requested a review from gewarren as a code owner June 12, 2024 22:14
@vernou
Copy link
Contributor Author

vernou commented Jun 17, 2024

This PR was more tricky that anticipated. I prefer to split it and do the asked modification about boilerplate code in another PR.
So I created the issue #41457 to follow up.

@vernou vernou requested a review from richlander June 17, 2024 19:59
Copy link
Member

@richlander richlander left a comment

Choose a reason for hiding this comment

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

Thanks! I think this is a good set of improvements. We can save the rest for the follow-on PR.

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

I agree with Rich that this is a great improvement. Once the one final modification is made, I'll merge it.

@BillWagner BillWagner merged commit 4281f27 into dotnet:main Jun 21, 2024
8 checks passed
@vernou vernou deleted the 40972-async-main branch June 21, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-csharp/svc fundamentals/subsvc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The "Main()" documentation is misleading about async
6 participants