Skip to content

Conversation

@dependabot
Copy link

@dependabot dependabot bot commented on behalf of github May 2, 2022

Bumps numpydoc from 1.1.0 to 1.3.1.

Release notes

Sourced from numpydoc's releases.

numpydoc 1.2.0

Requires Python 3.7+ and Sphinx 1.8+.

Implemented enhancements

Fixed bugs

  • How to specify that parameter can equal the string 'integer'? #341
  • Fix validation bug when parameter type is set of options. #347 (rossbar)
  • Escape newline in docstring. #345 (Carreau)
  • Correctly validate parameters under the "Other Parameters" section #337 (dcbr)
  • BUG: fix an incomplete check in Reader.\_error\_location #308 (rgommers)
  • MAINT: pytest ignore doc directory. #296 (rossbar)
  • DOC: fix inaccuracy in validate docstring. #294 (rossbar)
  • Fix param parsing. #286 (Carreau)
  • BUG: Properly parse See Also when summary on first line. #283 (Carreau)
  • BUG: fix role regex. #280 (Carreau)
  • fix splitting of parameter lines. #279 (Carreau)

Closed issues

  • Class methods (@​classmethod) are not documented using numpydoc #340
  • Exclude certain methods from METHODS section #338
  • Warnings is not allowed in "GL06" check #334
  • Add version to style guide #333
  • numpydoc does not render parameters as expected #329
  • 1.1.0: pytest warnings #324
  • RTD configuration - latest #321
  • Rendering of types in latest doc build #318
  • Anchors for individual sections in numpydoc doc? #317
  • Development documentation not up-to-date #311
  • Warning: autosummary: stub file not found #290
  • Wrong number of Parameter for numpy array. #285
  • syntax to document default values #284
  • Failed See Also Parsing. #281
  • Sphinx emits "WARNING: py:class reference target not found" with numpydoc 1.1.0 #275

... (truncated)

Changelog

Sourced from numpydoc's changelog.

1.3.1

Release date: 30 April 2022

Requires Python 3.7+ and Sphinx 3.0+.

Full Changelog <https://github.com/numpy/numpydoc/compare/v1.3.0...v1.3.1>__

Closed issues:

  • numpydoc-1.3.tar.gz on pypi is missing requirements/ needed by setup.py [#387](https://github.com/numpy/numpydoc/issues/387) <https://github.com/numpy/numpydoc/issues/387>__
  • What to do about Jinja2 dependency & supporting old sphinx versions [#380](https://github.com/numpy/numpydoc/issues/380) <https://github.com/numpy/numpydoc/issues/380>__
  • RFE: please update for jinja2 3.x [#376](https://github.com/numpy/numpydoc/issues/376) <https://github.com/numpy/numpydoc/issues/376>__
  • Test failures with Sphinx 4.5.0 [#373](https://github.com/numpy/numpydoc/issues/373) <https://github.com/numpy/numpydoc/issues/373>__

Merged pull requests:

  • Update doc requirements [#389](https://github.com/numpy/numpydoc/issues/389) <https://github.com/numpy/numpydoc/pull/389>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update manifest [#388](https://github.com/numpy/numpydoc/issues/388) <https://github.com/numpy/numpydoc/pull/388>__ (jarrodmillman <https://github.com/jarrodmillman>__)

1.3

Release date: 29 April 2022

Requires Python 3.7+ and Sphinx 3.0+.

Full Changelog <https://github.com/numpy/numpydoc/compare/v1.2.1...v1.3.0>__

Closed issues


-  Broken “many checks” link in validation chapter `[#378](https://github.com/numpy/numpydoc/issues/378) <https://github.com/numpy/numpydoc/issues/378>`__
-  1.2.1: pytest warnings `[#377](https://github.com/numpy/numpydoc/issues/377) <https://github.com/numpy/numpydoc/issues/377>`__

Merged pull requests

  • Require sphinx>3 [#385](https://github.com/numpy/numpydoc/issues/385) <https://github.com/numpy/numpydoc/pull/385>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update tests + coverage config to rm warnings. [#383](https://github.com/numpy/numpydoc/issues/383) <https://github.com/numpy/numpydoc/pull/383>__ (rossbar <https://github.com/rossbar>__)
  • MAINT: Dont import for version [#382](https://github.com/numpy/numpydoc/issues/382) <https://github.com/numpy/numpydoc/pull/382>__ (larsoner <https://github.com/larsoner>__)
  • Runtime verification of sphinx and jinja2 versions [#381](https://github.com/numpy/numpydoc/issues/381) <https://github.com/numpy/numpydoc/pull/381>__ (rossbar <https://github.com/rossbar>__)
  • DOC: fix broken link to built-in validation checks. [#379](https://github.com/numpy/numpydoc/issues/379) <https://github.com/numpy/numpydoc/pull/379>__ (rossbar <https://github.com/rossbar>__)
  • Add pre-commit hook / linter [#374](https://github.com/numpy/numpydoc/issues/374) <https://github.com/numpy/numpydoc/pull/374>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Remove deprecated numpydoc_edit_link [#372](https://github.com/numpy/numpydoc/issues/372) <https://github.com/numpy/numpydoc/pull/372>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Cleanup cruft [#371](https://github.com/numpy/numpydoc/issues/371) <https://github.com/numpy/numpydoc/pull/371>__ (jarrodmillman <https://github.com/jarrodmillman>__)

1.2.1

... (truncated)

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 close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor 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)

Bumps [numpydoc](https://github.com/numpy/numpydoc) from 1.1.0 to 1.3.1.
- [Release notes](https://github.com/numpy/numpydoc/releases)
- [Changelog](https://github.com/numpy/numpydoc/blob/main/doc/release_notes.rst)
- [Commits](numpy/numpydoc@v1.1.0...v1.3.1)

---
updated-dependencies:
- dependency-name: numpydoc
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Jun 13, 2022

Superseded by #93.

@dependabot dependabot bot closed this Jun 13, 2022
@dependabot dependabot bot deleted the dependabot/pip/numpydoc-1.3.1 branch June 13, 2022 13:17
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.

1 participant