Skip to content

Read-me references "Person" module #1543

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

Closed
brunnerh opened this issue Nov 8, 2022 · 3 comments · Fixed by #1698
Closed

Read-me references "Person" module #1543

brunnerh opened this issue Nov 8, 2022 · 3 comments · Fixed by #1698
Assignees
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Milestone

Comments

@brunnerh
Copy link

brunnerh commented Nov 8, 2022

In the Modules table there is this row:

Person faker.person.firstName() Cameron

Shouldn't this be the "Name" module and faker.name.firstName() function?

@ST-DDT
Copy link
Member

ST-DDT commented Nov 8, 2022

The next branch is our default branch (to simplify development).

In v8 the name module will be renamed to person, and thus the README was changed accordingly.
If you visit our current docs: https://fakerjs.dev/ or https://fakerjs.dev/api/name.html or https://github.com/faker-js/faker/tree/v7 then you will get the correct content for the latest released version.

Do you have a suggestion on how we could make this more obvious to or visitors?
Our "next" website https://next.fakerjs.dev/ has a banner for that, but unfortunately we don't have that option with github.

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: awaiting more info Additional information are requested labels Nov 8, 2022
@brunnerh
Copy link
Author

brunnerh commented Nov 9, 2022

I guess changing the default branch would be the only option. E.g. change branches to: ..., v6, current, next
current would then be the default and latest stable release (what now is v7). A new v branch would be created on major version releases.

Not sure how inconvenient that would be to manage, though.

@Shinigami92
Copy link
Member

In some repos I saw "hints" like

You are seeing the content of the next branch, if you want to see the vX please go to y

@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: awaiting more info Additional information are requested labels Dec 28, 2022
@ST-DDT ST-DDT moved this to Awaiting Review in Faker Roadmap Dec 28, 2022
@ST-DDT ST-DDT self-assigned this Dec 28, 2022
@github-project-automation github-project-automation bot moved this from Awaiting Review to Done in Faker Roadmap Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation 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.

3 participants