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

validation.notDocumented does not properly handle functions/methods #1895

Closed
Gerrit0 opened this issue Mar 26, 2022 · 0 comments
Closed

validation.notDocumented does not properly handle functions/methods #1895

Gerrit0 opened this issue Mar 26, 2022 · 0 comments
Labels
bug Functionality does not match expectation

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 26, 2022

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:

/** I really do have docs! */
export function foo() {}

Environment

  • Typedoc version: 0.22.13
  • TypeScript version: 4.6.2
  • Node.js version: 16
  • OS: Windows
@Gerrit0 Gerrit0 added the bug Functionality does not match expectation label Mar 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant