chore(dynamodb): update waitForReplicationToFinish flag summary doc to highlight that it may cause deletion for existing replicas.#31432
Conversation
…o highlight that it may cause deletion for existing replicas.
| readonly replicationTimeout?: Duration; | ||
|
|
||
| /** | ||
| * [WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] |
There was a problem hiding this comment.
Do the square brackets do something to format this in the dosctring? If not should we remove them like on like 356?
There was a problem hiding this comment.
to update the summary doc, either we need a paragraph of 20 words, or one sentence that follow this pattern https://github.com/aws/jsii/blob/37082de53576b9c807e83506af336458c6f2c6cb/packages/jsii/lib/docs.ts#L259-L261
that is why I added square brackets here to separate between the warning message, and the actual definition of this flag. I am open for better ideas :)
There was a problem hiding this comment.
Discussed with @moelasmar and the updated summary line in the table looks good. This is just a workaround to ensure that the warning and the original summary line both show up without the use of any punctuation which would cause the original summary line to be cut off.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
Description of changes
Add a warning message to the summary doc of the flag
waitForReplicationToFinishto highlight that misusing this flag may cause deletion for existing replicas. This change is required to resolve some internal feedback as some people may miss reading the detail documentation of that flag, and so they will may misuse it and then have some serious issues.Description of how you validated changes
see the below image for the updated doc:
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license