docs: add AES example and rules for example templates #177
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acioc
approved these changes
Jul 20, 2020
Comment on lines
+11
to
+14
| - [Python (DEV)](https://github.com/aws/aws-encryption-sdk-python/blob/keyring/examples/src/keyring/raw_aes/raw_aes.py) | ||
| - [Python Master Key Provider (DEV)](https://github.com/aws/aws-encryption-sdk-python/blob/keyring/examples/src/master_key_provider/raw_aes/raw_aes.py) | ||
| - [Java (DEV)](https://github.com/aws/aws-encryption-sdk-java/blob/keyring/src/examples/java/com/amazonaws/crypto/examples/keyring/rawaes/RawAes.java) | ||
| - [Java Master Key Provider (DEV)](https://github.com/aws/aws-encryption-sdk-java/blob/keyring/src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/rawaes/RawAes.java) |
There was a problem hiding this comment.
np: Should this be a table instead?
Also, what about JavaScript and C?
There was a problem hiding this comment.
Neither JS nor C have these examples yet. We use a simple list for similar things elsewhere; IMO if we only have one column it's not worth a table.
|
|
||
| ```python | ||
| # Encrypt your plaintext data. | ||
| ciphertext, _encrypt_header = aws_encryption_sdk.encrypt( |
There was a problem hiding this comment.
Suggested change
| ciphertext, _encrypt_header = aws_encryption_sdk.encrypt( | |
| ciphertext, encrypt_header = aws_encryption_sdk.encrypt( |
I wasn't sure if the _ was supposed to be there.
There was a problem hiding this comment.
It is, yes. In Python in this use, that denotes "I need to collect this variable and I want to give it a name for clarity, but I do not intend to ever use it."
mattsb42-aws
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
#143
Description of changes:
Add AES example and example template rules.
I don't think that adding the example template rules necessitate a change doc as I believe that they are covered under the intend of the examples change doc. I found them necessary to add in order to frame a template, and including a template in the change with them was useful both for me to clarify them for myself and to demonstrate how each section works.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.