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

Deprecate phone.number format parameter #1541

Closed
ST-DDT opened this issue Nov 7, 2022 · 2 comments · Fixed by #2229
Closed

Deprecate phone.number format parameter #1541

ST-DDT opened this issue Nov 7, 2022 · 2 comments · Fixed by #2229
Assignees
Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs deprecation A deprecation was made in the PR m: phone Something is referring to the phone module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Nov 7, 2022

Clear and concise description of the problem

The format can be used to overwrite the pattern that is used to generate the phone number.
Instead of passing it to phone.number the user should pass it directly to helpers.replaceSymbolWithNumber and build their own phone number method. Alternatively, they can add the format to our repository and thus provide it for everyone.

Suggested solution

Deprecate the format parameter for removal.

Alternative

Additional context

No response

@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs m: phone Something is referring to the phone module deprecation A deprecation was made in the PR labels Nov 7, 2022
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Nov 7, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Feb 16, 2023

Team Decision

  • We don't want the format parameter.

@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Feb 16, 2023
@xDivisionByZerox
Copy link
Member

In yesterdays meeting we completely skipped over the potential alternative you provided.
After having a look at that, I think it's a good proposal.

I just want to make clear, that I (we?) don't want the format parameter in it's current form as a custom template. Having a a format parameter which is a string union as proposed in #1542 seems fine to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs deprecation A deprecation was made in the PR m: phone Something is referring to the phone module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants