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

Update typedoc to v0.22.15 #782

Merged
merged 2 commits into from Apr 19, 2022
Merged

Update typedoc to v0.22.15 #782

merged 2 commits into from Apr 19, 2022

Commits on Apr 19, 2022

  1. Update typedoc to v0.22.15

    TypeDoc has been updated to the latest version. This version supports
    later TypeScript versions, allowing us to update `tsc` in a later PR.
    It also includes improvements to document generation, most importantly
    in the case where parameters are destructured [1].
    
    Versions v0.21.0 [2] and v0.22.0 [3] both included breaking changes,
    but none of them affect us.
    
    This new version included new console warnings that alerted me to a
    pre-existing problem that was introduced with v0.20.0, which is that
    many types are missing from our documentation. This is because TypeDoc
    will only include types that are exported from the package, and many of
    our internal types aren't exported from the package itself (even when
    they are exported from the module they're declared in). The plugin
    `typedoc-plugin-missing-exports` was added to address this. This plugin
    ensures that any types referenced in the docs are included in the docs,
    even if they aren't exported.
    
    [1]: TypeStrong/typedoc#1703
    [2]: https://github.com/TypeStrong/typedoc/releases/tag/v0.21.0
    [3]: https://github.com/TypeStrong/typedoc/releases/tag/v0.22.0
    Gudahtt committed Apr 19, 2022
    Configuration menu
    Copy the full SHA
    982561e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ccb82a5 View commit details
    Browse the repository at this point in the history