Skip to content

Update JSDOC ... (spread) definition #12388

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

Merged
merged 2 commits into from
Sep 4, 2022

Conversation

hasezoey
Copy link
Collaborator

@hasezoey hasezoey commented Sep 3, 2022

Summary

This PR updates all invalid spread JSDOC syntaxes and updated the documentation code to properly handle the spread.

also includes some updates to the documentation script types.

Note: {String} ...arg is invalid, the proper definition is {...String} arg, and because this is not directly included from dox in the name property, it is "moneky"-patched in

@hasezoey hasezoey added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Sep 3, 2022
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks 👍

@vkarpov15 vkarpov15 added this to the 6.5.5 milestone Sep 4, 2022
@vkarpov15 vkarpov15 merged commit 60e1888 into Automattic:master Sep 4, 2022
@hasezoey hasezoey deleted the updateSpread branch September 4, 2022 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants