You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
validation notDocumented does not have any documentation
Expected Behavior
From Discord:
Hello - I'm trying to use the new --validation.notDocumented flag in v0.22.13. I'm getting a ton of false positives. I'm not an expert, and only did some cursory debugging, but I think the logic is not sufficient. If the ReflectionKind is a method, the comment property will exist on the Signature, no? Therefore, this if is not sufficient for methods. Unless I'm missing something... (Also I see Reflection has a hasComment() method which I assume would be a better check)
Actual Behavior
TypeDoc incorrectly checks for documentation on function reflections, while requiring documentation for reflections really ought to transparently replaced with requiring documentation for call signatures.
Steps to reproduce the bug
Run TypeDoc with --validation.notDocumented on this code:
/** I really do have docs! */exportfunctionfoo(){}
Environment
Typedoc version: 0.22.13
TypeScript version: 4.6.2
Node.js version: 16
OS: Windows
The text was updated successfully, but these errors were encountered:
Search terms
validation notDocumented does not have any documentation
Expected Behavior
From Discord:
Hello - I'm trying to use the new --validation.notDocumented flag in v0.22.13. I'm getting a ton of false positives. I'm not an expert, and only did some cursory debugging, but I think the logic is not sufficient. If the ReflectionKind is a method, the comment property will exist on the Signature, no? Therefore, this if is not sufficient for methods. Unless I'm missing something... (Also I see Reflection has a hasComment() method which I assume would be a better check)
Actual Behavior
TypeDoc incorrectly checks for documentation on function reflections, while requiring documentation for reflections really ought to transparently replaced with requiring documentation for call signatures.
Steps to reproduce the bug
Run TypeDoc with
--validation.notDocumented
on this code:Environment
The text was updated successfully, but these errors were encountered: