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

Bump jsdoc from 3.5.5 to 3.6.2 #250

Closed

Conversation

dependabot-preview[bot]
Copy link
Contributor

@dependabot-preview dependabot-preview bot commented May 19, 2019

Bumps jsdoc from 3.5.5 to 3.6.2.

Changelog

Sourced from jsdoc's changelog.

3.6.2 (May 2019)

Fixes an issue that prevented ES 2015 classes from appearing in generated docs. ([#1644][1644])

3.6.1 (May 2019)

Prevents a crash when using type applications in Node.js 12. ([#1643][1643])

3.6.0 (May 2019)

Major changes

Enhancements

  • You can now use the templates.useShortNamesInLinks configuration setting to show the short name
    of each symbol in link text (for example, baz), rather than the full longname (for example,
    foo.bar.baz). ([Bump github/codeql-action from 1 to 2 #738][738])
  • When you enable the Markdown plugin, you can now specify a function that performs syntax
    highlighting in code blocks. ([#1412][1412])
  • The default template now places namespaces near the top of the TOC. ([#1410][1410])

Bug fixes

  • When you add a JSDoc comment to an ES2015 constructor, JSDoc now preserves all of the JSDoc tags,
    not only the description and parameters. ([#1129][1129])
  • The @exports tag now works correctly when it is combined with the @enum tag. ([[DEPENDENCY] Bump workerpool from 6.5.1 to 9.0.4 #970][970])
  • When you enable the Markdown plugin, and you use a code fence with the language set to plain,
    JSDoc no longer pretty-prints the code block in the generated documentation. ([#1361][1361])
Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

@coveralls
Copy link

coveralls commented May 19, 2019

Coverage Status

Coverage increased (+0.02%) to 85.948% when pulling 8ccaa45 on dependabot/npm_and_yarn/jsdoc-3.6.2 into df7c789 on master.

@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.2 branch from c50770d to 9c040b7 Compare May 26, 2019 04:25
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.2 branch 4 times, most recently from 8034204 to 9876024 Compare June 6, 2019 10:37
@CLAassistant
Copy link

CLAassistant commented Jun 6, 2019

CLA assistant check
All committers have signed the CLA.

@flovogt
Copy link
Member

flovogt commented Jun 14, 2019

Hi team,
would look to see that PR merged to get NPM warnings (npm audit) away.
Best Regards,
Florian

@codeworrior
Copy link
Member

JSDoc unfortunately has a bad record wrt. compatibility (at least from our experience). We are relying on some enhanced plugin capabilities of JSDoc (AST visitor, JSDoc events) which in the past made updates more difficult.

We'll look into this, sooner or later, but it's not just merging.

@flovogt
Copy link
Member

flovogt commented Jun 14, 2019

@codeworrior Thanks a lot for clarification. For me it looked like it's only a feature update and not a breaking change update.

@codeworrior
Copy link
Member

We recently had issues with upgrading from JSDoc 3.5.5 to JSDoc 3.6.0 or 3.6.1, see #247.

I'm aware of jsdoc/jsdoc#1643 and (a variant of) jsdoc/jsdoc#1644 .

Maybe the issues have all been fixed with 3.6.2, we have to check.

@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.2 branch 2 times, most recently from 20ad2db to 378859b Compare July 1, 2019 12:37
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.2 branch from 378859b to 4ce93f7 Compare July 7, 2019 04:33
Bumps [jsdoc](https://github.com/jsdoc/jsdoc) from 3.5.5 to 3.6.2.
- [Release notes](https://github.com/jsdoc/jsdoc/releases)
- [Changelog](https://github.com/jsdoc/jsdoc/blob/master/CHANGES.md)
- [Commits](jsdoc/jsdoc@3.5.5...3.6.2)

Signed-off-by: dependabot[bot] <support@dependabot.com>
@dependabot-preview dependabot-preview bot force-pushed the dependabot/npm_and_yarn/jsdoc-3.6.2 branch from 4ce93f7 to 8ccaa45 Compare July 14, 2019 04:34
@dependabot-preview
Copy link
Contributor Author

Superseded by #296.

@dependabot-preview dependabot-preview bot deleted the dependabot/npm_and_yarn/jsdoc-3.6.2 branch July 21, 2019 04:22
@RandomByte
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants