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

Docs include types from excluded files #1578

Closed
domoritz opened this issue Apr 26, 2021 · 6 comments · Fixed by redpeacock78/cie.js#6
Closed

Docs include types from excluded files #1578

domoritz opened this issue Apr 26, 2021 · 6 comments · Fixed by redpeacock78/cie.js#6
Labels
enhancement Improved functionality

Comments

@domoritz
Copy link

https://github.com/apache/arrow/blob/ca83a14e264d00c6b4b29560cc2816c6718f52e7/js/typedoc.js#L26 excludes src/fb/*.ts but the types from it still appear in the docs when built with yarn doc.

Screen Shot 2021-04-25 at 20 55 21

I would expect them to not be in the docs.

Environment

  • Typedoc version: 0.20.35
  • TypeScript version: 4.0.2
  • Node.js version: 14
  • OS: macOS
@domoritz domoritz added the bug Functionality does not match expectation label Apr 26, 2021
@Gerrit0 Gerrit0 added the no bug This is expected behavior label Apr 26, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 26, 2021

This is expected behavior:

This option will only be used to filter entry points specified under directories. - exclude docs

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 26, 2021

There is a plugin that provides the type of filtering you're looking for: https://github.com/Gerrit0/typedoc-plugin-banish... but I haven't checked if it works in 0.20.

Alternatively, the externalPattern along with excludeExternals options can be used to perform the same filtering.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 26, 2021

Thinking about this some more, it does seem reasonable to extend exclude to also work here. I'm open to treating this as a feature request. Needs to be a part of 0.21 though, breaking change.

@domoritz
Copy link
Author

domoritz commented Apr 26, 2021

Thank you for the suggestions. I'll try them. And yes, it would be great to refine the exclude behavior in the next version.

@domoritz
Copy link
Author

typedoc-plugin-banish does not seem to work

Screen Shot 2021-04-26 at 15 19 30

Screen Shot 2021-04-26 at 15 20 00

@domoritz
Copy link
Author

externalPattern does exactly what I want. I think it would make sense to make exclude work like externalPattern.

Screen Shot 2021-04-26 at 15 23 38

domoritz added a commit to domoritz/arrow that referenced this issue Apr 26, 2021
@Gerrit0 Gerrit0 added enhancement Improved functionality and removed bug Functionality does not match expectation no bug This is expected behavior labels Apr 27, 2021
@Gerrit0 Gerrit0 added this to To do in Version 0.21 via automation Apr 27, 2021
@Gerrit0 Gerrit0 moved this from To do to In progress in Version 0.21 May 1, 2021
@Gerrit0 Gerrit0 moved this from In progress to Done in Version 0.21 May 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants