-
Notifications
You must be signed in to change notification settings - Fork 486
yargs issue with docuemntation version 14.0.3 #1641
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
Comments
What Node version are you using? |
@tmcw I am using v10.24.1 |
That's the cause - see the release notes of v14: https://github.com/documentationjs/documentation/blob/master/CHANGELOG.md#1400-alpha0-2022-08-05 - the minimum supported Node version is 14. There was probably a warning message when you ran |
@tmcw I have updated node to latest version (v20.15.0) and still seeing same issue with documentation [email protected] |
I have package.json with following entries:
when I run npm run documentation, I get below error:
If I use older version (13.2.5), documentation works. The reason behind version upgrade is - when docstring are generated for method, it doesnt parse '&' for body param. Example:
For below docstring:
@param { Required<Pick<Model1, 'name'>> & Partial<Model1> } body specification
expectation is to see below format in documentation:
body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification
but I can see:
body(any) specification
The text was updated successfully, but these errors were encountered: