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

Fix dev docs #114

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Fix dev docs #114

merged 1 commit into from
Nov 3, 2023

Conversation

Timothy-Gonzalez
Copy link
Member

@Timothy-Gonzalez Timothy-Gonzalez commented Nov 3, 2023

Updates typedoc & plugin to latest, disables external dependency documenting. We really shouldn't be doing this anyways, as depending on other people's code to be commented in the right format is very iffy.

Summary about this issue if we want to fix it
[info] The comments for _id are declared at:
        ./node_modules/mongoose/types/document.d.ts:22
        ./node_modules/mongoose/types/document.d.ts:22
        ./node_modules/mongoose/types/document.d.ts:22
        ./node_modules/mongoose/types/document.d.ts:22
TypeDoc exiting with unexpected error:
RangeError: Maximum call stack size exceeded
    at get project [as project] (....\hackillinois\adonix\node_modules\typedoc\dist\lib\models\reflections\abstract.js:251:24)
    at get project [as project] (....\hackillinois\adonix\node_modules\typedoc\dist\lib\models\reflections\abstract.js:255:36)
    at get project [as project] (....\hackillinois\adonix\node_modules\typedoc\dist\lib\models\reflections\abstract.js:255:36)

Updates typedoc & plugin to latest, disables external dependency
documenting. We really shouldn't be doing this anyways, as depending on
other people's code to be commented in the right format is very iffy.
Copy link
Contributor

@AydanPirani AydanPirani left a comment

Choose a reason for hiding this comment

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

lgtm!

@Timothy-Gonzalez Timothy-Gonzalez merged commit 5e09100 into main Nov 3, 2023
5 checks passed
@Timothy-Gonzalez Timothy-Gonzalez deleted the dev/timothy/fix-dev-docs branch November 3, 2023 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants