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

Default parameter value not showing up in faker.date.recent documentation #1927

Closed
matthewmayer opened this issue Mar 14, 2023 · 3 comments · Fixed by #1931
Closed

Default parameter value not showing up in faker.date.recent documentation #1927

matthewmayer opened this issue Mar 14, 2023 · 3 comments · Fixed by #1931
Assignees
Labels
c: bug Something isn't working c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug

Comments

@matthewmayer
Copy link
Contributor

Screenshot 2023-03-14 at 16 55 44

For example no longer shows that faker.date.recent has a default of 1 for days

compare
https://fakerjs.dev/api/date.html#recent
and
https://next.fakerjs.dev/api/date.html#recent

Seems to be a regression from #1534

@ST-DDT
Copy link
Member

ST-DDT commented Mar 14, 2023

Likely caused by or debug-able here:

default: extractDefaultFromComment(property.comment),

@matthewmayer
Copy link
Contributor Author

matthewmayer commented Mar 14, 2023

i think the problem is previously parameter defaults were specified by writing "Defaults to Foo." at the end of the @param declaration but these were removed and replaced by @default Foo. So either analyzeParameterOptions needs to be modified to add support for the @default option or need to add back Defauults to 1. on this and similar options.

@ST-DDT ST-DDT self-assigned this Mar 14, 2023
@ST-DDT ST-DDT added c: bug Something isn't working c: docs Improvements or additions to documentation s: accepted Accepted feature / Confirmed bug labels Mar 14, 2023
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Mar 14, 2023
@ST-DDT ST-DDT moved this to In Progress in Faker Roadmap Mar 14, 2023
@ST-DDT
Copy link
Member

ST-DDT commented Mar 14, 2023

I'll have a look.

@ST-DDT ST-DDT added the p: 1-normal Nothing urgent label Mar 14, 2023
@ST-DDT ST-DDT moved this from In Progress to Awaiting Review in Faker Roadmap Mar 14, 2023
@github-project-automation github-project-automation bot moved this from Awaiting Review to Done in Faker Roadmap Mar 20, 2023
@ST-DDT ST-DDT linked a pull request Mar 20, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: bug Something isn't working 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.

2 participants