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

Reference to wrong parameter name "size": should be "count" #10895

Open
robertpba opened this issue Jan 31, 2025 · 2 comments · May be fixed by #10905
Open

Reference to wrong parameter name "size": should be "count" #10895

robertpba opened this issue Jan 31, 2025 · 2 comments · May be fixed by #10905
Assignees
Labels
needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners 📌 seQUESTered Identifies that an issue has been imported into Quest. untriaged New issue has not been triaged by the area owner

Comments

@robertpba
Copy link

robertpba commented Jan 31, 2025

Type of issue

Typo

Description

Method Read(Byte[], Int32, Int32) is declared as:
public override int Read (byte[] buffer, int offset, int count);

However, in the following documentation, reference is made to parameter size. This should instead be count.

Instances where the wrong parameter name is being used:

  • size is less than 0.
  • size is greater than the length of buffer minus offset.
  • The Read operation reads as much data as is available, up to the number of bytes specified by the size parameter.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.net.sockets.networkstream.read?view=net-9.0#system-net-sockets-networkstream-read(system-byte()-system-int32-system-int32)

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Net.Sockets/NetworkStream.xml

Document Version Independent Id

b40c2ef4-b8a0-8de3-e71d-baf1aaae541b

Article author

@karelz


Associated WorkItem - 368782

@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Jan 31, 2025
@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jan 31, 2025
Copy link

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.

1 similar comment
Copy link

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.

@gewarren gewarren self-assigned this Feb 3, 2025
@gewarren gewarren added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Feb 3, 2025
gewarren added a commit to gewarren/dotnet-api-docs that referenced this issue Feb 4, 2025
@gewarren gewarren linked a pull request Feb 4, 2025 that will close this issue
@gewarren gewarren moved this from 🔖 Ready to 👀 In review in dotnet/docs February 2025 sprint project Feb 4, 2025
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners 📌 seQUESTered Identifies that an issue has been imported into Quest. untriaged New issue has not been triaged by the area owner
Projects
Status: 👀 In review
Development

Successfully merging a pull request may close this issue.

2 participants