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

SemaphoreSlim constructor parameter doc #79995

Closed
pepone opened this issue Dec 27, 2022 · 5 comments · Fixed by #80085
Closed

SemaphoreSlim constructor parameter doc #79995

pepone opened this issue Dec 27, 2022 · 5 comments · Fixed by #80085

Comments

@pepone
Copy link
Contributor

pepone commented Dec 27, 2022

/// <paramref name="maxCount"/> is less than 0.</exception>

Looking at this code, the doc should say is less than or equal to zero

@dotnet-issue-labeler
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.

@ghost ghost added the untriaged New issue has not been triaged by the area owner label Dec 27, 2022
@ghost
Copy link

ghost commented Dec 27, 2022

Tagging subscribers to this area: @mangod9
See info in area-owners.md if you want to be subscribed.

Issue Details

/// <paramref name="maxCount"/> is less than 0.</exception>

Looking at this code, the doc should say is less than or equal to zero

Author: pepone
Assignees: -
Labels:

area-System.Threading, untriaged

Milestone: -

@bjornen77
Copy link
Contributor

I can try to put up a PR for this if wanted.

@danmoseley
Copy link
Member

A PR would be great.

Looks like the actual docs are correct, I guess they are not yet generated from the code in this case:

https://learn.microsoft.com/en-us/dotnet/api/system.threading.semaphoreslim.-ctor?view=net-7.0#system-threading-semaphoreslim-ctor(system-int32-system-int32)

bjornen77 added a commit to bjornen77/runtime that referenced this issue Dec 31, 2022
Corrected an error in the XML documentation.

Fix dotnet#79995
@ghost ghost added the in-pr There is an active PR which will close this issue when it is merged label Dec 31, 2022
@bjornen77
Copy link
Contributor

I changed the XML documentation to the same wording as the other docs mentioned above.

@ghost ghost removed in-pr There is an active PR which will close this issue when it is merged untriaged New issue has not been triaged by the area owner labels Jan 1, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Jan 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants