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

Non-intuitive error if options property doesn't have jsdocs #3079

Closed
matthewmayer opened this issue Sep 1, 2024 · 2 comments · Fixed by #3082
Closed

Non-intuitive error if options property doesn't have jsdocs #3079

matthewmayer opened this issue Sep 1, 2024 · 2 comments · Fixed by #3082
Assignees
@ST-DDT
Labels
c: infra Changes to our infrastructure or project setup p: 1-normal Nothing urgent
Milestone
vAnytime

Comments

@matthewmayer
Copy link
Contributor

FakerApiDocsProcessingError: Failed to process parameter options at src/modules/number/index.ts:468:16 : Expected exactly one element for jsdocs, got 0

Originally posted by @AmaanRS in #3070 (comment)
@matthewmayer
Copy link
Contributor Author

matthewmayer commented Sep 1, 2024 •
edited
Loading

i think previously the verify @since tag in https://github.com/faker-js/faker/blob/next/test/scripts/apidocs/verify-jsdoc-tags.spec.ts would throw the error expecting @since to be present but after merge of #2628 the exactlyOne() function in value-checks.ts is throwing a more cryptic error which doesnt mention @since

@ST-DDT ST-DDT changed the title Non-intuitive error if @since is missing in jsdoc Non-intuitive error if options property doesn't have jsdocs Sep 1, 2024
@ST-DDT ST-DDT self-assigned this Sep 1, 2024
@ST-DDT ST-DDT added p: 1-normal Nothing urgent c: infra Changes to our infrastructure or project setup labels Sep 1, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Sep 1, 2024
@ST-DDT
Copy link
Member

ST-DDT commented Sep 1, 2024

Correction, the error is caused by the options properties (min and max) not having jsdocs.

@ST-DDT ST-DDT mentioned this issue Sep 1, 2024
Merged
@faker-js faker-js deleted a comment from wedouglas Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ST-DDT ST-DDT

Labels
c: infra Changes to our infrastructure or project setup p: 1-normal Nothing urgent
Projects
None yet
Milestone
vAnytime
Development

Successfully merging a pull request may close this issue.

infra: improve error messages for parameter properties faker-js/faker
2 participants
@matthewmayer @ST-DDT