Skip to content

Update securitypolicy struct names and docstrings#1278

Closed
anmaxvl wants to merge 1 commit intomicrosoft:mainfrom
anmaxvl:security-policy-updates
Closed

Update securitypolicy struct names and docstrings#1278
anmaxvl wants to merge 1 commit intomicrosoft:mainfrom
anmaxvl:security-policy-updates

Conversation

@anmaxvl
Copy link
Copy Markdown
Contributor

@anmaxvl anmaxvl commented Jan 14, 2022

During initial implementation a few things were skipped and the
plan was to address them later. Some of the things include missing
docstrings on exported security policy structs, methods and
interfaces.
This PR addresses above by splitting existing comments on the
Policy struct and putting them closer to the actual implementation.
Additionally fix inconsistencies with typical golang naming
conventions.

Signed-off-by: Maksim An maksiman@microsoft.com

@anmaxvl
Copy link
Copy Markdown
Contributor Author

anmaxvl commented Jan 14, 2022

@SeanTAllen FYI

@anmaxvl anmaxvl force-pushed the security-policy-updates branch from 10aa780 to be74c28 Compare January 14, 2022 03:07
@SeanTAllen
Copy link
Copy Markdown
Contributor

I think while making this change, we should seriously consider changing the name "SecurityPolicy".

The issue with "security policy" that I've found is that people assume there's something "active" that is going on. And in a way there is, but not how the word leads people to imagine it. What we are doing really is taking a wide-open environment and constraining it to only allow what the user has indicated should happen. It is a subtle but important difference.

That said, I do not have a better idea at the moment for a name.

During initial implementation a few things were skipped and the
plan was to address them later. Some of the things include missing
docstrings on exported security policy structs, methods and
interfaces.
This PR addresses above by splitting existing comments on the
Policy struct and putting them closer to the actual implementation.
Additionally fix inconsistencies with typical golang naming
conventions.

Signed-off-by: Maksim An <maksiman@microsoft.com>
@anmaxvl anmaxvl force-pushed the security-policy-updates branch from be74c28 to 023e7dd Compare January 15, 2022 01:43
@anmaxvl anmaxvl requested a review from a team January 15, 2022 01:44
@anmaxvl
Copy link
Copy Markdown
Contributor Author

anmaxvl commented Jan 18, 2022

As mentioned in PR description, wait until #1279 is merged.

@anmaxvl anmaxvl closed this Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants