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

Arrow functions not being included when excludeNotDocumented is true #2156

Closed
jonathanchaffer opened this issue Jan 30, 2023 · 1 comment
Closed

Arrow functions not being included when excludeNotDocumented is true #2156

jonathanchaffer opened this issue Jan 30, 2023 · 1 comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@jonathanchaffer
Copy link

Search terms

arrow, function, const

Expected Behavior

Arrow functions (like const foo = () => {}) should be documented correctly when excludeNotDocumented is true.

Actual Behavior

They are being incorrectly excluded from the generated docs, even when they have JSDoc comments on them.

Steps to reproduce the bug

See repro: https://github.com/jonathanchaffer/typedoc-repros

Environment

  • Typedoc version: 0.23.24
  • TypeScript version: 4.9.4
  • Node.js version: 14.17.6
  • OS: macOS 13.0
@jonathanchaffer jonathanchaffer added the bug Functionality does not match expectation label Jan 30, 2023
@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Feb 1, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 11, 2023

Thanks for the repro! I forgot to consider how signature comment inheritance worked there.

@baltpeter baltpeter mentioned this issue Feb 28, 2023
Open
baltpeter added a commit to tweaselORG/appstraction that referenced this issue Feb 28, 2023
@baltpeter
Upgrade TypeDoc
3f13b34 
This fixes arrow functions not being included in the docs with our
config (TypeStrong/typedoc#2156).
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 good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Gerrit0 @jonathanchaffer