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

Rename aws_types::Config to aws_types::SdkConfig` #406

Closed
Velfi opened this issue Jan 18, 2022 · 6 comments
Closed

Rename aws_types::Config to aws_types::SdkConfig` #406

Velfi opened this issue Jan 18, 2022 · 6 comments
Assignees
Labels
breaking-change This issue requires a breaking change to remediate. feature-request A feature should be added or improved.

Comments

@Velfi
Copy link
Contributor

Velfi commented Jan 18, 2022

Tell us about your request

Rename aws_types::Config to aws_types::SdkConfig

Tell us about the problem you're trying to solve.

Users struggle to understand the difference between a Config struct from a service SDK and a Config struct from aws_types. Renaming the type would make users less likely to think the Config structs are interchangeable.

Are you currently working around this issue?

It's possible to alias the type but this doesn't help users that don't already know the difference

Additional context

No response

@Velfi Velfi added feature-request A feature should be added or improved. breaking-change This issue requires a breaking change to remediate. labels Jan 18, 2022
@benesch
Copy link
Contributor

benesch commented Jan 29, 2022

Yes, please! This was one of my primary sources of confusion when learning the SDK.

One note: SharedConfig is easy to misinterpret. The correct interpretation is “configuration common to all SDK clients” (right?) but it’s reminiscent of a “global shared configuration object” like an Arc.

CommonConfig strikes me as maybe a bit clearer?

I definitely retract my suggestion if there’s prior art in other SDKs that use the “Shared” terminology, though.

@Velfi
Copy link
Contributor Author

Velfi commented Mar 8, 2022

This is now in PR

@Velfi Velfi changed the title Rename aws_config::Config to aws_config::SharedConfig` Rename aws_types::Config to aws_types::SdkConfig` Mar 14, 2022
@Velfi Velfi added the pending-release This issue will be fixed by an approved PR that hasn't been released yet. label Mar 14, 2022
@Velfi
Copy link
Contributor Author

Velfi commented Mar 14, 2022

The PR has been merged and this feature is now pending release. Per a poll we held on the internal AWS Slack, we decided on SdkConfig over SharedConfig. Chief among the reasons why we made that choice is that we already use the word Shared to prefix names of types that are wrapped in an Arc.

@benesch
Copy link
Contributor

benesch commented Mar 14, 2022

The PR has been merged and this feature is now pending release. Per a poll we held on the internal AWS Slack, we decided on SdkConfig over SharedConfig. Chief among the reasons why we made that choice is that we already use the word Shared to prefix names of types that are wrapped in an Arc.

SdkConfig sounds great to me, too!

@jdisanti
Copy link
Contributor

This was released with v0.9.0.

@github-actions
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.

@rcoh rcoh removed the pending-release This issue will be fixed by an approved PR that hasn't been released yet. label Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change This issue requires a breaking change to remediate. feature-request A feature should be added or improved.
Projects
Archived in project
Development

No branches or pull requests

4 participants