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.

Sign up for GitHub

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

Jump to bottom

Documentation not rendered for optional interface methods #1490

Closed
jnordberg opened this issue Jan 31, 2021 · 1 comment
Closed

Documentation not rendered for optional interface methods #1490

jnordberg opened this issue Jan 31, 2021 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@jnordberg
Copy link

jnordberg commented Jan 31, 2021 •
edited

Search terms

Optional method, function, interface declaration, missing, not working

Expected Behavior

Should render the docstrings for optional methods in an interface

Actual Behavior

Does not render

Screen Shot 2021-01-31 at 13 30 12

Steps to reproduce the bug

interface MyThing {
  /** This is documented. */
  doThing(): void
  /** This isn't. */
  doAnotherThing?(): void
}

Environment

  • Typedoc version: 0.20.19
  • TypeScript version: 4.1.3
  • Node.js version: v15.4.0
  • OS: macOS 11
@jnordberg jnordberg added the bug Functionality does not match expectation label Jan 31, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 31, 2021

Thanks for the reproduction! That was an easy fix at least... will be included in 0.20.20

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Functionality does not match expectation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jnordberg @Gerrit0