Adjust snippet clipping in S3 Glacier example#37
Adjust snippet clipping in S3 Glacier example#37Paul-B-AWS merged 1 commit intoawsdocs:masterfrom camerondurham:master
Conversation
camerondurham
changed the title
|
@camerondurham, thanks for raising this issue and also for the pointers to other possible anomalies. |
|
@camerondurham Regarding your comment about the Python build looking significantly different from the web site... For example, look at the first 11 lines of create_vault.go. The local build, on the other hand, doesn't account for the web-build behavior, so starts counting code lines from the beginning of the original code example file. Hope this explanation helps. |
|
@Paul-B-AWS Thank you for the really thorough explanation! That complexity of doc-building is new to me and the details will be helpful in case I submit another PR for this. |
2 participants
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
importsection is clipped andfuncis missing on CloudWatch Disable Actions On An Alarm.I have run
python build_docs.py singlehtmlbut 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.