improve ByteStream docs & add pub use #443
Merged
Conversation
This file contains 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
This commit attempts to improve the discoverability and useability of `ByteStream`: 1. Adds pub use for bytestream. This is currently added to all crates. At some point in the future, we may wish to prune this to crates that actually use it, but as it doesn't actually add an additional dependency, there isn't currently any harm. SdkBody is explicitly _not_ pub use'd. Generally, people shouldn't need to use `SdkBody` directly. 2. Clarifies, adds examples, and generally increases the scope of the `ByteStream` documentation.
jdisanti
approved these changes
Jun 1, 2021
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.
Description of changes:
This commit attempts to improve the discoverability and useability of
ByteStream:Adds pub use for bytestream. This is currently added to all crates. At some point in the future, we may wish to prune this to crates that actually use it, but as it doesn't actually add an additional dependency, there isn't currently any harm.
SdkBody is explicitly not pub use'd. Generally, people shouldn't need to use
SdkBodydirectly.Clarifies, adds examples, and generally increases the scope of the
ByteStreamdocumentation.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.