This repository has been archived by the owner on Jun 15, 2023. It is now read-only.
Adjust snippet clipping in S3 Glacier example #37
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:No open issues found.
Description of changes:
Dedent the code snippet to avoid clipping in Glacier example:
Matching closest file that includes full file as snippet rather than pieces: https://github.com/awsdocs/aws-go-developer-guide/blob/master/doc_source/kms-example-create-key.rst
From briefly looking over all snippets in the doc, I believe this is the only full file snippet with this issue. However, there are other clipping errors such as in this file where the
import
section is clipped andfunc
is missing on CloudWatch Disable Actions On An Alarm.I have run
python build_docs.py singlehtml
but unable to completely verify changes locally since the output looked significantly different than current docs. I opted to make a smaller change that exactly matched similar files. I can file an issue with how the doc build failed if desired but all snippets were all off by ~15 lines after the script successfully ran (with warnings).By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Thanks for considering this change! I'm not sure if this repository or SDK is still active but do plan to test and use this. README seems to suggest this repo is still used.