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.

Sign up for GitHub

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

Jump to bottom

docs(cognito): Fix grammar in summaries of UserPool IDPs #29254

Closed
douglasnaphas opened this issue Feb 26, 2024 · 3 comments · Fixed by #29255
Closed

docs(cognito): Fix grammar in summaries of UserPool IDPs #29254

douglasnaphas opened this issue Feb 26, 2024 · 3 comments · Fixed by #29255
Labels
@aws-cdk/aws-cognito Related to Amazon Cognito documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@douglasnaphas
Copy link
Contributor

Describe the issue

The summaries in docstrings for classes beginning with UserPoolIdentityProvider use the wrong article (a identity instead of an identity) and have social identity provider names improperly quoted.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderAmazon.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderApple.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderFacebook.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderGoogle.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderOidc.html
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolIdentityProviderSaml.html
@douglasnaphas douglasnaphas added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 26, 2024
@github-actions github-actions bot added the @aws-cdk/aws-cognito Related to Amazon Cognito label Feb 26, 2024
douglasnaphas added a commit to douglasnaphas/aws-cdk that referenced this issue Feb 26, 2024
@douglasnaphas
Fix grammar in UserPool IDP docstrings
0ded7a7 
Closes awsgh-29254.
@douglasnaphas douglasnaphas mentioned this issue Feb 26, 2024
Merged
1 task
@tim-finnigan tim-finnigan self-assigned this Feb 26, 2024
@tim-finnigan tim-finnigan added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Feb 26, 2024
@tim-finnigan
Copy link

Thanks for the PR! Looks like those are valid changes, although I'm not sure the quotes around 'Login with Amazon' need to be removed. Someone from the team will review and decide.

@tim-finnigan tim-finnigan added p2 and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Feb 26, 2024
@tim-finnigan tim-finnigan removed their assignment Feb 26, 2024
@tim-finnigan tim-finnigan added the effort/small Small work item – less than a day of effort label Feb 26, 2024
@douglasnaphas
Copy link
Contributor Author

Thanks for the PR! Looks like those are valid changes, although I'm not sure the quotes around 'Login with Amazon' need to be removed. Someone from the team will review and decide.

Thanks.

The docs for Login with Amazon do not quote it: https://developer.amazon.com/docs/login-with-amazon/documentation-overview.html.

I do not believe there is any grammar rule that supports using quotation marks for a system or a commercial service.

Here is a typical statement of the situations when quotes can be correct:
https://www.grammarly.com/blog/quotation-marks

Single quotes here are especially unusual.

@mergify mergify bot closed this as completed in #29255 Feb 27, 2024
mergify bot pushed a commit that referenced this issue Feb 27, 2024
@douglasnaphas
chore(cognito): fix grammar in UserPool IDP docstrings (#29255)
cfd93b9 
Closes gh-29254.

### Issue # (if applicable)

Closes #29254.

### Reason for this change



This fixes minor grammar issues in docs.

### Description of changes



I made no functional code changes, only changes to docs via comments. I made no design decisions.

### Description of how you validated changes



Doc changes only.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions GitHub Actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot mentioned this issue Mar 1, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-cognito Related to Amazon Cognito documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(cognito): fix grammar in UserPool IDP docstrings douglasnaphas/aws-cdk
2 participants
@douglasnaphas @tim-finnigan