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

[Break Change] Rename APIs new_with_* to with_* #119

Open
TennyZhuang opened this issue Sep 19, 2022 · 1 comment
Open

[Break Change] Rename APIs new_with_* to with_* #119

TennyZhuang opened this issue Sep 19, 2022 · 1 comment

Comments

@TennyZhuang
Copy link

TennyZhuang commented Sep 19, 2022

In Rust's official naming guide, the recommanded constructor names should be new or with_more_details, and almost all stdlib APIs follow the guide.

This may introduce a break change so that a new major version should be released, feel free to close the issue if you think it's non-critical. This is only a suggestion.

@jonhoo
Copy link
Collaborator

jonhoo commented Sep 19, 2022

Makes sense to me! I wouldn't remove the old ones though, just mark them as deprecated. Keeping around the new_ variants until we otherwise need to make a breaking change seems more reasonable.

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

No branches or pull requests

2 participants