Update AddMember.java comments#9886
Conversation
Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format.
ghost
left a comment
There was a problem hiding this comment.
Hi @melaniedejong and reviewers,
I'm currently reviewing this pull request and will post my full review in a few minutes. In the meantime, here's a quick summary to help everyone get up to speed:
This pull request updates the comments in AddMember.java to improve clarity and accuracy.
Intent:
The main goal is to replace the term "member" with "principal" throughout the code and comments for better alignment with Google Cloud IAM terminology. Additionally, instead of specifying a recommended format for principal identifiers, the updated comments now link to the official Google Cloud documentation page for principal identifiers.
Changes:
- The file
iam/snippets/src/main/java/AddMember.javahas been modified:- Lines 29-30: The comment
// TODO: Replace with your member.has been changed to// TODO: Replace with your principal. // For examples, see https://cloud.google.com/iam/docs/principal-identifiersThe placeholdermembervariable is updated to reflect the change. - Line 35: The comment
// Adds a member to a pre-existing role.is updated to// Adds a principal to a pre-existing role. - Line 47: The comment
// Update the policy to add the member.is updated to// Update the policy to add the principal.
- Lines 29-30: The comment
These changes ensure consistency with Google Cloud IAM terminology and provide users with a direct link to relevant documentation.
Here's a little haiku to lighten the mood:
Code flows like a stream,
Clear comments guide the way,
Reviews bring the sun.
Let me know if you have any questions!
Best,
Gemini
|
Gemini encountered an error creating the review. You can try again by commenting |
* Update Quickstart.java comments Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. * Update AddMember.java comments (#9886) Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. * Update AddBinding.java Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. melaniedejong-patch-1 (#4895) * Update RemoveMember.java comments Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. * Update Quickstart.java * Update AddMember.java
Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format.
Description
Fixes #
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
pom.xmlparent set to latestshared-configurationmvn clean verifyrequiredmvn -P lint checkstyle:checkrequiredmvn -P lint clean compile pmd:cpd-check spotbugs:checkadvisory only