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

[Docs] Fix async function anchors #13226

Merged
merged 2 commits into from Apr 4, 2023
Merged

Conversation

hasezoey
Copy link
Collaborator

@hasezoey hasezoey commented Apr 1, 2023

Summary

This PR fixes dox not being able to recognize async function as proper function, resulting in anchors of Model.ensureIndexes instead of Model.ensureIndexes()

also includes a fix to automatically convert the old improper anchors to the new ones (if existing)

See tj/dox#198

@hasezoey hasezoey added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Apr 1, 2023
@hasezoey hasezoey added this to the 7.0.4 milestone Apr 1, 2023
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.

LGTM. Maybe time to re-open #8925 ?

@vkarpov15 vkarpov15 merged commit c77180b into Automattic:master Apr 4, 2023
1 check passed
@hasezoey hasezoey deleted the fixAsyncFn branch April 4, 2023 14:31
@hasezoey
Copy link
Collaborator Author

hasezoey commented Apr 4, 2023

LGTM. Maybe time to re-open #8925 ?

maybe, but i dont know with what to replace it with aside from typedoc, for now dox works and can be worked-around

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