-
Notifications
You must be signed in to change notification settings - Fork 21
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
chore(deps): update dependency jsdoc-to-markdown to v9 #730
base: develop
Are you sure you want to change the base?
Conversation
|
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
98cec73
to
0c391c8
Compare
0c391c8
to
4a803b7
Compare
9d36217
to
a4f3bd8
Compare
a4f3bd8
to
b4025d6
Compare
b4025d6
to
dc505ef
Compare
dc505ef
to
ea9ea5a
Compare
This PR contains the following updates:
8.0.3
->9.1.1
Release Notes
jsdoc2md/jsdoc-to-markdown (jsdoc-to-markdown)
v9.1.1
Compare Source
Non-breaking changes since v9.1.0
@link
,@linkcode
and@linkplain
tags are resolved in the@deprecated
tag text.v9.1.0
Compare Source
New feature since v9.0.5
@deprecated
tag is now displayed. #90Upgrade notes
See this testbed directory for example source code and output.
Previously, the tag
@deprecated This method has been deprecated since v2.0.0
would simply print***Deprecated***
in the output, ignoring the deprecation text. The new behaviour:@deprecated
tag with no text, display***Deprecated***
(same as before).@deprecated This method has been deprecated since v2.0.0
, then the full text line will be printed as written***Deprecated***
line with***This method has been deprecated since v2.0.0***
.v9.0.5
Compare Source
Non-breaking changes since v9.0.4
v9.0.4
Compare Source
Non-breaking change
util.isRegExp is not a function
issue in Node v23, replacing the previous temporary workaround. #306v9.0.3
Compare Source
Non-breaking change
util.isRegExp is not a function
issue in Node v23: #306v9.0.2
Compare Source
Non-breaking
--EOL
failed to correctly replace naked CR characters created by jsdoc. jsdoc2md/dmd#102v9.0.1
Compare Source
v9.0.0
Compare Source
The default output has not changed. The minimum required Node version is still v12.17. The goals for this release were bug fixing and simplification. Feel free to comment in the release discussion or post an issue.
Breaking changes since v8.0.3
.renderSync()
,.getTemplateDataSync()
and.getJsdocDataSync()
. The jsdoc2md API is now async-only.option.files
oroption.source
was mandatory. Now, it is eitheroption.files
,option.source
oroption.configure
. https://github.com/jsdoc2md/jsdoc-api/issues/27Non-breaking changes
template
option. #303{@​linkcode}
and{@​linkplain}
. #301--EOL
option to control line-endings. Fixes https://github.com/jsdoc2md/dmd/issues/92.{ pedantic: false }
confused the underlying jsdoc. https://github.com/jsdoc2md/jsdoc-api/issues/22.source
. https://github.com/jsdoc2md/jsdoc-api/issues/11@hideconstructor
. https://github.com/jsdoc2md/dmd/issues/94@module
tag required) https://github.com/jsdoc2md/dmd/issues/96@example
was excluded in the output if the doclet did not contain a description. https://github.com/jsdoc2md/jsdoc-parse/issues/33Other improvements
Upgrade notes
.renderSync()
,.getTemplateDataSync()
and.getJsdocDataSync()
with their async equivalents.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.