dotnet / dotnet/dotnet-api-docs

Confusing terminology in SafeHandle example code

Open Beginner friendly
#12,959 0 comments 0 reactions 0 assignees View on GitHub
area-System.Runtime.InteropServices untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

### Describe the issue or suggestion

As this is a part of .NET that is very basic, for new programmers to understand. The wording:
> this SafeHandle instance "owns" the handle

seems clumsy. It would be more clear if it instead doesn't conflate instantiation with implementation. Something like:
> informing the base class that the instance of this SafeHandle implementation "owns" the handle

https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.safehandle?view=net-10.0

Contributor guide

Open the contributing guide

Research direction

Open the linked SafeHandle API reference page and locate the example wording that says the SafeHandle instance "owns" the handle. Revise the wording to clarify that the SafeHandle implementation informs its base class that it owns the handle, then verify the page reads clearly for new programmers.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.