Skip to content

Upgrade typedoc to version 0.24.5#439

Closed
depfu[bot] wants to merge 1 commit into
developfrom
depfu/update/npm/typedoc-0.24.5
Closed

Upgrade typedoc to version 0.24.5#439
depfu[bot] wants to merge 1 commit into
developfrom
depfu/update/npm/typedoc-0.24.5

Conversation

@depfu

@depfu depfu Bot commented Apr 23, 2023

Copy link
Copy Markdown

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ typedoc (^0.17.4 → ^0.24.5) · Repo · Changelog

Release Notes

0.24.5

Features

  • Categories and groups can now be shown in the navigation, added --navigation.includeCategories
    and --navigation.includeGroups to control this behavior. The --categorizeByGroup option also
    effects this behavior. If categorizeByGroup is set (the default) and navigation.includeGroups is
    not set, the value of navigation.includeCategories will be effectively ignored since categories
    will be created only within groups, #1532.
  • Added support for discovering a "module" comment on global files, #2165.
  • Added copy code to clipboard button, #2153.
  • Function @returns blocks will now be rendered with the return type, #2180.
  • Added --groupOrder option to specify the sort order of groups, #2251.

Bug Fixes

  • Type parameter constraints now respect the --hideParameterTypesInTitle option, #2226.
  • Even more contrast fixes, #2248.
  • Fix semantic highlighting for predicate type's parameter references, #2249.
  • Fixed broken links to heading titles.
  • Fixed inconsistent styling between type parameter lists and parameter lists.
  • TypeDoc will now warn if more than one @returns block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.

Thanks!

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 14 commits:


Depfu Status

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands
@​depfu rebase
Rebases against your default branch and redoes this update
@​depfu recreate
Recreates this PR, overwriting any edits that you've made to it
@​depfu merge
Merges this PR once your tests are passing and conflicts are resolved
@​depfu close
Closes this PR and deletes the branch
@​depfu reopen
Restores the branch and reopens this PR (if it's closed)
@​depfu pause
Ignores all future updates for this dependency and closes this PR
@​depfu pause [minor|major]
Ignores all future minor/major updates for this dependency and closes this PR
@​depfu resume
Future versions of this dependency will create PRs again (leaves this PR as is)

@depfu depfu Bot added the depfu label Apr 23, 2023
@depfu

depfu Bot commented Apr 25, 2023

Copy link
Copy Markdown
Author

Closed in favor of #441.

@depfu depfu Bot closed this Apr 25, 2023
@depfu depfu Bot deleted the depfu/update/npm/typedoc-0.24.5 branch April 25, 2023 04:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants