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

System.Security readonly annotation #51783

Closed
wants to merge 4 commits into from

Conversation

hrrrrustic
Copy link
Contributor

This PR is a part of #46675

@dotnet-issue-labeler
Copy link

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost
Copy link

ghost commented Apr 24, 2021

Tagging subscribers to this area: @bartonjs, @vcsjones, @krwq, @GrabYourPitchforks
See info in area-owners.md if you want to be subscribed.

Issue Details

This PR is a part of #46675

Author: hrrrrustic
Assignees: -
Labels:

area-System.Security, new-api-needs-documentation

Milestone: -

@hrrrrustic hrrrrustic changed the title System.Net.Security readonly annotation System.Security readonly annotation Apr 24, 2021
@GrabYourPitchforks
Copy link
Member

GrabYourPitchforks commented Apr 24, 2021

Thanks for submitting this! At first glance my gut tells me that these changes may cast too wide a net. For example, one of the modified types is a ref struct "reader" type, and it's never expected for such types to be passed via "in" parameters.

As Steve said in the original issue, we also want to ensure that for our public APIs, the newly annotated methods will never at any point in the future need to modify state. So we'll need to confer on these to narrow down what public API contract changes would be appropriate to take as a long-term behavioral guarantee.

@jeffhandley
Copy link
Member

This PR is being marked as a draft per #46675 (comment).

@jeffhandley jeffhandley marked this pull request as draft April 29, 2021 20:42
@ghost ghost closed this May 29, 2021
@ghost
Copy link

ghost commented May 29, 2021

Draft Pull Request was automatically closed for inactivity. Please let us know if you'd like to reopen it.

@ghost ghost locked as resolved and limited conversation to collaborators Jun 28, 2021
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants