-
Notifications
You must be signed in to change notification settings - Fork 697
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
validation.notDocumented
doesn't correctly handle some cases
#1898
Comments
I also just noticed that for some incredibly strange reason it ignores The following method definition: class SomeClass {
/** @internal */
foobar(
first: string,
second: string,
third: string,
fourth: string,
fifth: string,
sixth: string,
seventh: string,
eighth: string
) {
first;
second;
third;
fourth;
fifth;
sixth;
seventh;
eighth;
}
} Fails with the error:
|
Note to self, never accept a feature without a large battery of tests... I'm also being reminded of how much I dislike TypeDoc's use of reflections for object types :/ |
Heh, I know the feeling. I just had to revert a nice looking change in one of my projects that completely failed in production because I didn't test it enough. Thankfully this particular bug is in a non-critical section, and only really matters if you have both |
This is an easy bug at least. First thing I checked was the issue. TypeDoc |
Yeah that'll do it! Removing things from arrays while iterating over them is so easy, it's one of my favorite things (massive /s). At least it was an easy fix. If my guess is correct the function types will be easy as well. Good luck on the other two though, they seem like they'll be a pain. |
Well, there's that fixed... hopefully this lasts longer than the other one before horrible bugs are discovered ;) |
I can confirm that my project now passes without error when run against ea16a7b! I'm probably not using every possible reflected type, but I ran with |
Search terms
function type definitions, methods with computed names, generated types
Expected Behavior
Enabling
validation.notDocumented
should correctly report on:type Foo = () => void
)Actual Behavior
All of the above cases falsely report that they are undocumented.
Steps to reproduce the bug
npm run gendoc
Environment
The text was updated successfully, but these errors were encountered: