Add / fix smithy-client docs #855
Conversation
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
| @@ -122,6 +122,24 @@ fn find_source<'a, E: Error + 'static>(err: &'a (dyn Error + 'static)) -> Option | |||
|
|
|||
| #[derive(Default, Debug)] | |||
| /// Builder for [`HyperAdapter`] | |||
| /// | |||
There was a problem hiding this comment.
Should this doc comment go on HyperAdapter itself? At least when I was digging into the docs, that's where I landed first, and then made my way into the builder doc once I knew I wanted to use it and needed to construct it.
| /// use aws_smithy_client::erase::DynConnector; | ||
| /// let hyper_connector = hyper_ext::Adapter::builder().build(conns::https()); | ||
| /// // this client can then be used when constructing a Smithy Client | ||
| /// // NOTE: in real usage, you will almost certainly want a real middleware implementation |
There was a problem hiding this comment.
What do you mean by this note?
| /// use aws_smithy_client::erase::DynConnector; | ||
| /// let hyper_connector = hyper_ext::Adapter::builder().build(conns::https()); |
There was a problem hiding this comment.
| /// use aws_smithy_client::erase::DynConnector; | |
| /// let hyper_connector = hyper_ext::Adapter::builder().build(conns::https()); | |
| /// use aws_smithy_client::erase::DynConnector; | |
| /// | |
| /// let hyper_connector = hyper_ext::Adapter::builder().build(conns::https()); |
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
| pub struct HyperAdapter<C>(HttpReadTimeout<hyper::Client<ConnectTimeout<C>, SdkBody>>); | ||
| pub struct Adapter<C>(HttpReadTimeout<hyper::Client<ConnectTimeout<C>, SdkBody>>); |
There was a problem hiding this comment.
Isn't this a breaking change that should get called out?
There was a problem hiding this comment.
no, we were publicly exporting it as Adapter
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
Co-authored-by: John DiSanti <jdisanti@amazon.com>
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
|
A new generated diff is ready to view: __generated-main...__generated-docs-fix |
Motivation and Context
Improve docs for constructing smithy clients
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.