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

Move clients::mutex to sync module #326

Merged
merged 4 commits into from
Jun 15, 2022

Conversation

SabrinaJewson
Copy link
Contributor

Description

Rename clients::mutex to sync and add doc comments to it.

Motivation and Context

clients::mutex shouldn’t really be inside clients IMO because it has nothing inherently to do with the differerent clients. I was considering removing the module entirely, but I think it’s nice to keep it contained. sync is a better name than mutex since it’s more general.

Dependencies

None.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

  • Test A: cargo test --no-default-features --features client-reqwest,reqwest-default-tls,env-file
  • Test B: cargo test --no-default-features --features client-ureq,ureq-rustls-tls,env-file

Is this change properly documented?

I will add a changelog entry.

@marioortizmanero
Copy link
Collaborator

marioortizmanero commented Jun 15, 2022

Thanks a lot for the contributions!

Looks good to me! The only nitpick I have is that maybe sync::sync should be renamed to sync::blocking? It seems less confusing. It's even pointed out by clippy (haha, I like that the lint is called module-inception).

@SabrinaJewson
Copy link
Contributor Author

Good point, I’ve done that. I do run Clippy locally but it didn’t complain about it for some reason…how strange.

@marioortizmanero
Copy link
Collaborator

marioortizmanero commented Jun 15, 2022

Yeah, since it's a workspace you have to use cargo clippy --all or something like that. I think. I'll merge after you do a cargo fmt, it seems like the imports aren't sorted anymore :P

Edit: oh, and there are conflicts now

@marioortizmanero marioortizmanero merged commit 23ee2bc into ramsayleung:master Jun 15, 2022
@SabrinaJewson SabrinaJewson deleted the sync-module branch June 15, 2022 14:35
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.

2 participants