Skip to content

Benefits of unsafe code are ambiguously stated #47073

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 2, 2025

Working on issue #20665 to clarify that unsafe code itself doesn't provide performance benefits - it enables writing different algorithms that may be faster.

Plan:

  • Identify the problematic statement in /docs/csharp/language-reference/unsafe-code.md line 25
  • Understand the issue: current wording "unsafe code can increase performance by removing array bounds checks" is ambiguous
  • Update the wording to clarify that unsafe code enables writing different algorithms, not automatic performance gains
  • Verify the change maintains accuracy and clarity
  • Test that the documentation still renders correctly

Change made:

- In some cases, unsafe code can increase an application's performance by removing array bounds checks.
+ Unsafe code enables algorithms that can potentially increase an application's performance by using pointers to avoid array bounds checks.

Why this addresses the issue:

  • "enables algorithms" - clarifies that unsafe code provides capabilities, not automatic performance
  • "by using pointers to avoid" - specifically explains how performance is achieved through pointer usage
  • Removes ambiguous "removing" language that suggested automatic optimization
  • Makes clear that you need to write different algorithms using pointers for performance benefits

The change is minimal and surgical, addressing only the ambiguous statement identified in the issue.

Fixes #20665.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/csharp/language-reference/unsafe-code.md docs/csharp/language-reference/unsafe-code

@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Jul 2, 2025
…n providing them automatically

Co-authored-by: BillWagner <[email protected]>
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.

This LGTM. It's ready for final review

@BillWagner
Copy link
Member

@copilot can you finish any further changes here?

Copy link
Contributor Author

Copilot AI commented Jul 3, 2025

@copilot can you finish any further changes here?

Yes, I've completed the final remaining task from the plan. I validated that the documentation renders correctly using markdownlint-cli2 (0 errors) and markdown-link-check (valid structure). The change is ready for final review.

@BillWagner BillWagner marked this pull request as ready for review July 3, 2025 14:02
@BillWagner BillWagner requested a review from a team as a code owner July 3, 2025 14:02
@Copilot Copilot AI requested a review from BillWagner July 3, 2025 14:02
Copilot finished work on behalf of BillWagner July 3, 2025 14:02
@BillWagner BillWagner enabled auto-merge (squash) July 3, 2025 14:02
@BillWagner
Copy link
Member

@IEvangelist PTAL

@BillWagner BillWagner changed the title [WIP] Benefits of unsafe code are ambiguously stated Benefits of unsafe code are ambiguously stated Jul 3, 2025
@BillWagner BillWagner requested review from IEvangelist and a team July 3, 2025 15:51
…s capabilities rather than algorithms

Co-authored-by: jkotas <[email protected]>
auto-merge was automatically disabled July 3, 2025 21:47

Head branch was pushed to by a user without write access

@Copilot Copilot AI requested a review from jkotas July 3, 2025 21:47
Copilot finished work on behalf of jkotas July 3, 2025 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
advanced-concepts/subsvc dotnet-csharp/svc lang-reference/subsvc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Benefits of unsafe code are ambiguously stated
3 participants