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.

Sign up for GitHub

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

Jump to bottom

Deprecate company.name index parameter #1178

Closed
ST-DDT opened this issue Jul 22, 2022 · 3 comments · Fixed by #1212
Closed

Deprecate company.name index parameter #1178

ST-DDT opened this issue Jul 22, 2022 · 3 comments · Fixed by #1212
Assignees
@Minozzzi
Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs good first issue Good for newcomers m: company Something is referring to the company module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone
v7 - Current Major

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Jul 22, 2022 •
edited
Loading

Clear and concise description of the problem

faker/src/modules/company/index.ts

Line 36 in fbddaa3

companyName(format?: number): string {

Using an index parameter is equal to using a fixed pattern, any changes on our side to the patterns would potentially break client code.

Suggested solution

The parameter should be deprecated for removal. Users should either hardcode the pattern themselves or use a random pattern.

Alternative

No response

Additional context

The method is being renamed in #1166.
@ST-DDT ST-DDT added s: pending triage Pending Triage good first issue Good for newcomers p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs and removed s: pending triage Pending Triage labels Jul 22, 2022
@ST-DDT ST-DDT added this to the v7 - Current Major milestone Jul 22, 2022
@ST-DDT ST-DDT moved this to Awaiting Review in Faker Roadmap Jul 22, 2022
@ST-DDT ST-DDT mentioned this issue Jul 22, 2022
Closed
@Minozzzi
Copy link
Contributor

This issue is to be done after or before #1179?

@ST-DDT
Copy link
Member Author

ST-DDT commented Jul 22, 2022

I think before #1179 but after #1166 .

@Minozzzi
Copy link
Contributor

The #1166 already been merged. I would like to do this task too. Can you assign to me?

@ejcheng ejcheng moved this from Awaiting Review to In Progress in Faker Roadmap Jul 22, 2022
@xDivisionByZerox xDivisionByZerox added the m: company Something is referring to the company module label Jul 29, 2022
@ejcheng ejcheng linked a pull request Jul 30, 2022 that will close this issue
refactor(company.name): deprecate format parameter #1212
Merged
Repository owner moved this from In Progress to Done in Faker Roadmap Jul 30, 2022
@Minozzzi Minozzzi mentioned this issue Jul 30, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Minozzzi Minozzzi

Labels
c: refactor PR that affects the runtime behavior, but doesn't add new features or fixes bugs good first issue Good for newcomers m: company Something is referring to the company module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v7 - Current Major
Development

Successfully merging a pull request may close this issue.

refactor(company.name): deprecate format parameter Minozzzi/faker
3 participants
@ST-DDT @Minozzzi @xDivisionByZerox