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

Using @ignore now renders empty ignore block #1396

Closed
tanepiper opened this issue Nov 19, 2020 · 1 comment
Closed

Using @ignore now renders empty ignore block #1396

tanepiper opened this issue Nov 19, 2020 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@tanepiper
Copy link

Search terms

ignore, rendering

Expected Behavior

In a barrel file for Typescript, using the @ignore tag should ignore the file completly

Actual Behavior

In the rendered documentation an empty 'ignore' block is rendered

Steps to reproduce the bug

Example Barrel: https://github.com/tanepiper/rxjs-primitives/blob/master/libs/rxjs/array/src/index.ts
Typedoc config: https://github.com/tanepiper/rxjs-primitives/blob/master/typedoc.json

Run typedoc, generate output to docs: https://tanepiper.github.io/rxjs-primitives/modules/array.html

Screenshot 2020-11-19 at 21 44 55

Environment

  • Typedoc version: 0.19.2, typedoc-plugin-external-module-name: 4.0.3
  • TypeScript version: 4.05
  • Node.js version: 13.14.0
  • OS: OSX 10.15.7
@tanepiper tanepiper added the bug Functionality does not match expectation label Nov 19, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 25, 2020

Fixed in 0.20.0-beta.11 (though likely not quite in the way you expect, library based docs changes what it means to "ignore" a reflection somewhat), looks like you may have found a workaround in the meantime - nice looking docs! I like it better than TypeDoc's default theme.

@Gerrit0 Gerrit0 added this to To do in Version 0.20 via automation Nov 25, 2020
@Gerrit0 Gerrit0 moved this from To do to Done in Version 0.20 Nov 25, 2020
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
No open projects
Development

No branches or pull requests

2 participants