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 helpers.userCard/contextualCard/createCard #528

Closed
ST-DDT opened this issue Feb 20, 2022 · 4 comments · Fixed by #543
Closed

Deprecate helpers.userCard/contextualCard/createCard #528

ST-DDT opened this issue Feb 20, 2022 · 4 comments · Fixed by #543
Assignees
Labels
c: feature Request for new feature good first issue Good for newcomers p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug

Comments

@ST-DDT
Copy link
Member

ST-DDT commented Feb 20, 2022

These methods place a maintenance burden on this library while providing little benefit to the users.
Users that need a specific data object usually require custom data structures that can be easily defined in a self-managed method.
We should only provide methods for standardized data structures directly.

@ST-DDT ST-DDT added the c: feature Request for new feature label Feb 20, 2022
@ST-DDT ST-DDT added this to the v6.1 - First bugfixes milestone Feb 20, 2022
@ST-DDT ST-DDT self-assigned this Feb 20, 2022
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Feb 20, 2022
@ejcheng ejcheng added the p: 1-normal Nothing urgent label Feb 20, 2022
@ST-DDT ST-DDT removed their assignment Feb 20, 2022
@ST-DDT ST-DDT added the good first issue Good for newcomers label Feb 20, 2022
@sprohaszka
Copy link
Contributor

sprohaszka commented Feb 22, 2022

Hello @ST-DDT.
To be sure to understand, you only want to add deprecated JSDoc flag?

Update of the README should also being done: examples with the use of createCard exists

@ST-DDT
Copy link
Member Author

ST-DDT commented Feb 22, 2022

The deprecation consists of two parts:
@deprecated jsdocs and a console.log warning.

Example:

faker/src/random.ts

Lines 57 to 64 in 03c3d11

* @deprecated
*/
number(
options?: number | { min?: number; max?: number; precision?: number }
): number {
console.warn(
'Deprecation Warning: faker.random.number is now located in faker.datatype.number'
);

In addition to that the examples should be removed from the readme.

@sprohaszka
Copy link
Contributor

Tell me you're ok with the wording.

@ST-DDT ST-DDT moved this from Todo to Awaiting Review in Faker Roadmap Feb 22, 2022
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Mar 18, 2022
@Shinigami92 Shinigami92 moved this from Awaiting Review to Todo in Faker Roadmap Mar 23, 2022
@Shinigami92 Shinigami92 linked a pull request Mar 23, 2022 that will close this issue
@Shinigami92
Copy link
Member

Was not linked to the PR, already solved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: feature Request for new feature good first issue Good for newcomers p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants