Skip to content

docs(iam): add return values of policy validation methods#20350

Merged
mergify[bot] merged 2 commits intoaws:masterfrom
laurelmay:document-policydoc-validate-return
May 16, 2022
Merged

docs(iam): add return values of policy validation methods#20350
mergify[bot] merged 2 commits intoaws:masterfrom
laurelmay:document-policydoc-validate-return

Conversation

@laurelmay
Copy link
Copy Markdown
Contributor

Because these just return a list of strings it may not be clear to a
caller what the validation methods are actually returning. This @returns
text is based on the documentation in core's Construct.validate
documentation.


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Because these just return a list of strings it may not be clear to a
caller what the validation methods are actually returning. This
`@returns` text is based on the documentation in core's
Construct.validate documentation.
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented May 14, 2022

@aws-cdk-automation aws-cdk-automation requested a review from a team May 14, 2022 19:11
@github-actions github-actions bot added the p2 label May 14, 2022
@TheRealAmazonKendra TheRealAmazonKendra changed the title docs(iam): Document return values of validation methods docs(iam): add return values of policy validation methods May 16, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 16, 2022

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit 861a2bb into aws:master May 16, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 16, 2022

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 9c1ed9c
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@laurelmay laurelmay deleted the document-policydoc-validate-return branch May 16, 2022 15:44
wphilipw pushed a commit to wphilipw/aws-cdk that referenced this pull request May 23, 2022
Because these just return a list of strings it may not be clear to a
caller what the validation methods are actually returning. This `@returns`
text is based on the documentation in core's Construct.validate
documentation.


----

### All Submissions:

* [X] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants