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

@since values are wrong for faker.person.* #1479

Closed
9 of 10 tasks
matthewmayer opened this issue Oct 23, 2022 · 4 comments · Fixed by #1516
Closed
9 of 10 tasks

@since values are wrong for faker.person.* #1479

matthewmayer opened this issue Oct 23, 2022 · 4 comments · Fixed by #1516
Assignees
@matthewmayer
Labels
c: bug Something isn't working c: docs Improvements or additions to documentation good first issue Good for newcomers m: person Something is referring to the person module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone
v8.0 - Module Re-...

Comments

@matthewmayer
Copy link
Contributor

Pre-Checks

Describe the bug

On
https://next.fakerjs.dev/api/person.html#firstname

it lists "Available since v2.0.1" - this should be updated to "Available since v8.0.0" due to the whole module rename in #1343

Minimal reproduction code

No response

Additional Context

No response

Environment Info

System:
    OS: macOS 12.6
    CPU: (8) x64 Apple M1
    Memory: 22.25 MB / 8.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 14.20.0 - /usr/local/bin/node
    npm: 8.19.1 - /usr/local/bin/npm
  Browsers:
    Chrome: 106.0.5249.119
    Firefox: 91.0.2
    Safari: 16.0

Which module system do you use?

  • CJS
  • ESM

Used Package Manager

npm
@matthewmayer matthewmayer added c: bug Something isn't working s: pending triage Pending Triage labels Oct 23, 2022
@ST-DDT
Copy link
Member

ST-DDT commented Oct 24, 2022 •
edited
Loading

I have been looking at this multiple times now.
I'm still not sure about it, but I think it will be better, if we change the @since values accordingly.

@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug m: string Something is referring to the string module c: docs Improvements or additions to documentation and removed s: pending triage Pending Triage labels Oct 24, 2022
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Oct 24, 2022
@ST-DDT ST-DDT moved this to Todo in Faker Roadmap Oct 24, 2022
@ST-DDT ST-DDT added good first issue Good for newcomers m: person Something is referring to the person module and removed m: string Something is referring to the string module labels Oct 24, 2022
@Shinigami92
Copy link
Member

Shinigami92 commented Oct 25, 2022 •
edited
Loading

I have been looking at this multiple times now. I'm still not sure about it, but I think it will be better, if we change the @since values accordingly.

Is it okay if we talk about this next meeting?

@ST-DDT ST-DDT added s: needs decision Needs team/maintainer decision and removed s: accepted Accepted feature / Confirmed bug labels Oct 25, 2022
@ST-DDT
Copy link
Member

ST-DDT commented Nov 3, 2022 •
edited
Loading

Team decision

We should adjust the @since tags since the way of accessing the method has changed.
If users look at our documentation on our website they see a version and expect the method to be present in that version.

@matthewmayer Would you like to create a PR for this?

@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Nov 3, 2022
@matthewmayer matthewmayer mentioned this issue Nov 4, 2022
Merged
@matthewmayer
Copy link
Contributor Author

added PR for faker.person and faker.location

Repository owner moved this from Todo to Done in Faker Roadmap Nov 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matthewmayer matthewmayer

Labels
c: bug Something isn't working c: docs Improvements or additions to documentation good first issue Good for newcomers m: person Something is referring to the person module p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v8.0 - Module Re-Shuffling
Development

Successfully merging a pull request may close this issue.

docs: update since tags for person and location matthewmayer/faker
3 participants
@matthewmayer @ST-DDT @Shinigami92