-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Update XML docs for IntPtr
and UIntPtr
#69614
Comments
I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label. |
I'll be updating this alongside a PR I'm working on once the official build is finished and I can consume the new language functionality. Based on past build times, I should have bits within the hour. |
This also applies to the constructors and other members like |
Tagging subscribers to this area: @dotnet/area-system-numerics Issue DetailsThe XML docs summary for
This is also shown in the IDE when hovering over Now that the C# native integer types are being unified with
As opposed to "Often used", maybe it could say something like "Formerly, this has been used to represent a pointer or a handle." or somehow mention that it's especially been this way historically. I noticed this in dotnet/roslyn#61431
|
This is being handled by dotnet/dotnet-api-docs#8132 |
The XML docs summary for
IntPtr
andUIntPtr
currently says:This is also shown in the IDE when hovering over
nint
andnuint
:Now that the C# native integer types are being unified with
IntPtr
andUIntPtr
, I think their docs should be updated to mention that they're also used to represent native integer types in general, and it's not just for pointers and handles. Maybe something like this:Int32
currently: "Represents a 32-bit signed integer."IntPtr
could be: "Represents a native word-sized signed integer. Often used to represent a pointer or a handle."or "Represents a platform-specific signed integer. Often..."
UInt32
currently: "Represents a 32-bit unsigned integer."UIntPtr
could be: "Represents a native word-sized unsigned integer. Often used to represent a pointer or a handle."or "Represents a platform-specific unsigned integer. Often..."
As opposed to "Often used", maybe it could say something like "Formerly, this has been used to represent a pointer or a handle." or somehow mention that it's especially been this way historically.
I noticed this in dotnet/roslyn#61431
@jcouv @tannergooding
The text was updated successfully, but these errors were encountered: