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

renamed PolywrapClient to Client #234

Merged
merged 2 commits into from
Sep 6, 2023
Merged

renamed PolywrapClient to Client #234

merged 2 commits into from
Sep 6, 2023

Conversation

krisbitney
Copy link
Contributor

@krisbitney krisbitney commented Aug 31, 2023

Closes #236

@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Patch coverage is 100.00% of modified lines.

❗ Current head 65c4dfe differs from pull request most recent head 74af126. Consider uploading reports for the commit 74af126 to get more accurate results

Files Changed Coverage
packages/core/src/client.rs ø
packages/client/src/client.rs 100.00%
packages/core/src/resolution/helpers.rs 100.00%
packages/native/src/builder.rs 100.00%
packages/native/src/client.rs 100.00%
packages/plugins/logger/src/lib.rs 100.00%

📢 Thoughts on this report? Let us know!.

@krisbitney krisbitney requested review from namesty, nerfZael, pileks, dOrgJelli, cbrzn and Niraj-Kamdar and removed request for namesty September 1, 2023 13:58
Copy link
Collaborator

@cbrzn cbrzn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is awesome! thanks for pushing this 🙏

do you think we should also change the PolywrapClientConfigBuilder to ClientConfigBuilder? As well as PolywrapClientConfig to ClientConfig? (In another PR ofc)

CONTRIBUTING.md Show resolved Hide resolved
@krisbitney
Copy link
Contributor Author

this is awesome! thanks for pushing this 🙏

do you think we should also change the PolywrapClientConfigBuilder to ClientConfigBuilder? As well as PolywrapClientConfig to ClientConfig? (In another PR ofc)

Yes, that make sense. I'll make those changes!


#[derive(Default, Clone)]
pub struct PolywrapClientConfig {
pub struct ClientConfig {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i feel that this should be something like ClientBuilderConfig and the CoreClientConfig be ClientConfig - I feel that the Core prefix is non intuitive. Wdyt? Also cc to @namesty and @nerfZael to see what they think

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should make the most user-facing type the easiest to understand and read. So, that would mean that the config used by the builder is the ClientConfig, and the "fully built config" that's used by the client would be the CoreClientConfig.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should make the most user-facing type the easiest to understand and read. So, that would mean that the config used by the builder is the ClientConfig, and the "fully built config" that's used by the client would be the CoreClientConfig.

yah in my opinion that's not the easiest to understand and read but rather confusing. if I see this for the first time I would ask to myself "what's the difference between a client and a core client" and why do they have different attributes. from my perspective, this can be really simplified to say that one is the builder attributes and the other is the client attributes (but again, this is my opinion and I can be completely wrong)

Copy link
Collaborator

@cbrzn cbrzn Sep 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

anyways, I will merge this because it is a nit, and there's no need to block this

Copy link
Member

@dOrgJelli dOrgJelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🔥

@cbrzn cbrzn merged commit 3264a1d into main Sep 6, 2023
2 checks passed
@cbrzn cbrzn deleted the kris/rename-client branch September 6, 2023 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename PolywrapClient to Client
3 participants