Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated aws_smithy_runtime::client::http::hyper_014::HyperConnector rustdoc example referencing DefaultHttpsTcpConnector #986

Closed
declanvk opened this issue Dec 1, 2023 · 5 comments
Assignees
Labels
documentation This is a problem with documentation p2 This is a standard priority issue pending-release This issue will be fixed by an approved PR that hasn't been released yet.

Comments

@declanvk
Copy link
Contributor

declanvk commented Dec 1, 2023

Describe the issue

As the title says, there is a rustdoc referencing a non-existent type DefaultHttpsTcpConnector in:

/// ```no_run,ignore
/// use aws_smithy_runtime::client::connectors::hyper_connector::{DefaultHttpsTcpConnector, HyperConnector};
///
/// let hyper_connector = HyperConnector::builder().build(DefaultHttpsTcpConnector::new());
///
/// // This connector can then be given to a generated service Config
/// let config = my_service_client::Config::builder()
/// .endpoint_url("http://localhost:1234")
/// .http_connector(hyper_connector)
/// .build();
/// let client = my_service_client::Client::from_conf(config);
/// ```

I think that instead this should be instead be something directly from the hyper crate, similar to what is used in the tests:

.build(hyper_0_14::client::HttpConnector::new_with_resolver(
mock.dns_resolver(),
));

Links

@declanvk declanvk added documentation This is a problem with documentation needs-triage This issue or PR still needs to be triaged. labels Dec 1, 2023
@rcoh rcoh added p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Dec 2, 2023
@jdisanti jdisanti self-assigned this Dec 5, 2023
@jdisanti jdisanti moved this to In Progress in AWS Rust SDK Public Roadmap Dec 5, 2023
@jdisanti
Copy link
Contributor

jdisanti commented Dec 5, 2023

Thanks for reporting this! Working on a fix.

jdisanti added a commit to smithy-lang/smithy-rs that referenced this issue Dec 5, 2023
Moves the doc comments from HyperConnector to HyperClientBuilder where
they're more relevant, and fixes the examples.

This fix is for awslabs/aws-sdk-rust#986.
jdisanti added a commit to smithy-lang/smithy-rs that referenced this issue Dec 5, 2023
Moves the doc comments from HyperConnector to HyperClientBuilder where
they're more relevant, and fixes the examples.

This fix is for awslabs/aws-sdk-rust#986.
@jdisanti jdisanti added the pr/needs-review This PR needs a review from a Member. label Dec 5, 2023
github-merge-queue bot pushed a commit to smithy-lang/smithy-rs that referenced this issue Dec 5, 2023
Moves the doc comments from HyperConnector to HyperClientBuilder where
they're more relevant, and fixes the examples.

This fix is for awslabs/aws-sdk-rust#986.

----

_By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice._
@jdisanti jdisanti added pr/ready-to-merge This PR is ready to be merged. pending-release This issue will be fixed by an approved PR that hasn't been released yet. and removed pr/needs-review This PR needs a review from a Member. pr/ready-to-merge This PR is ready to be merged. labels Dec 5, 2023
@jdisanti jdisanti moved this from In Progress to Pending Release in AWS Rust SDK Public Roadmap Dec 5, 2023
@jdisanti
Copy link
Contributor

jdisanti commented Dec 5, 2023

This will be fixed in an upcoming release.

@declanvk
Copy link
Contributor Author

declanvk commented Dec 5, 2023

This will be fixed in an upcoming release.

Thank you for the quick work!

@jdisanti
Copy link
Contributor

The fix for this went out in the December 14th release.

@github-project-automation github-project-automation bot moved this from Pending Release to Done in AWS Rust SDK Public Roadmap Dec 14, 2023
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation p2 This is a standard priority issue pending-release This issue will be fixed by an approved PR that hasn't been released yet.
Projects
Status: Done
Development

No branches or pull requests

3 participants