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 numpydoc from 1.1.0 to 1.6.0 #254

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 26, 2023

Bumps numpydoc from 1.1.0 to 1.6.0.

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.6.0

Release date: 21 August 2023

Requires Python 3.8+ and Sphinx 5+.

Full Changelog <https://github.com/numpy/numpydoc/compare/v1.5.0...v1.6.0>__

Closed issues


-  ``numpydoc ignore`` inline comment not recognized when using decorators `[#495](https://github.com/numpy/numpydoc/issues/495) <https://github.com/numpy/numpydoc/issues/495>`__
-  Align pre-commit and Sphinx rule override syntax `[#466](https://github.com/numpy/numpydoc/issues/466) <https://github.com/numpy/numpydoc/issues/466>`__
-  Use pyproject.toml `[#473](https://github.com/numpy/numpydoc/issues/473) <https://github.com/numpy/numpydoc/issues/473>`__
-  rtd is failing `[#471](https://github.com/numpy/numpydoc/issues/471) <https://github.com/numpy/numpydoc/issues/471>`__
-  circleci-artifacts-redirector-action error `[#469](https://github.com/numpy/numpydoc/issues/469) <https://github.com/numpy/numpydoc/issues/469>`__
-  Incorporate a pre-commit hook for numpydoc validation `[#450](https://github.com/numpy/numpydoc/issues/450) <https://github.com/numpy/numpydoc/issues/450>`__
-  PR06 fails when offending type name is used only as a substring `[#446](https://github.com/numpy/numpydoc/issues/446) <https://github.com/numpy/numpydoc/issues/446>`__
-  style of ``[1]`` is strange in numpydoc docs `[#443](https://github.com/numpy/numpydoc/issues/443) <https://github.com/numpy/numpydoc/issues/443>`__
-  Double click on function parameter selects parameter type as well `[#427](https://github.com/numpy/numpydoc/issues/427) <https://github.com/numpy/numpydoc/issues/427>`__

Merged pull requests

  • Bump actions/checkout from 3 to 4 [#504](https://github.com/numpy/numpydoc/issues/504) <https://github.com/numpy/numpydoc/pull/504>__ (dependabot[bot] <https://github.com/apps/dependabot>__)
  • [pre-commit.ci] pre-commit autoupdate [#501](https://github.com/numpy/numpydoc/issues/501) <https://github.com/numpy/numpydoc/pull/501>__ (pre-commit-ci[bot] <https://github.com/apps/pre-commit-ci>__)
  • BUG: validator now handles properties [#500](https://github.com/numpy/numpydoc/issues/500) <https://github.com/numpy/numpydoc/pull/500>__ (sdiebolt <https://github.com/sdiebolt>__)
  • Fix clean_backref for extensions that have backrefs to inline elements. [#499](https://github.com/numpy/numpydoc/issues/499) <https://github.com/numpy/numpydoc/pull/499>__ (mcmtroffaes <https://github.com/mcmtroffaes>__)
  • BUG: validator now handles decorators [#496](https://github.com/numpy/numpydoc/issues/496) <https://github.com/numpy/numpydoc/pull/496>__ (sdiebolt <https://github.com/sdiebolt>__)
  • TST: Test no-file for source [#493](https://github.com/numpy/numpydoc/issues/493) <https://github.com/numpy/numpydoc/pull/493>__ (larsoner <https://github.com/larsoner>__)
  • Use label-check and attach-next-milestone-action [#492](https://github.com/numpy/numpydoc/issues/492) <https://github.com/numpy/numpydoc/pull/492>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Remove old linter check (using precommit bot now) [#491](https://github.com/numpy/numpydoc/issues/491) <https://github.com/numpy/numpydoc/pull/491>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update pydata-sphinx-theme [#490](https://github.com/numpy/numpydoc/issues/490) <https://github.com/numpy/numpydoc/pull/490>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Use dependabot to update actions [#489](https://github.com/numpy/numpydoc/issues/489) <https://github.com/numpy/numpydoc/pull/489>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Add config for pre-commit bot [#488](https://github.com/numpy/numpydoc/issues/488) <https://github.com/numpy/numpydoc/pull/488>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update pre-commits [#487](https://github.com/numpy/numpydoc/issues/487) <https://github.com/numpy/numpydoc/pull/487>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Sync updates to generate_requirements.py from scikit-image [#485](https://github.com/numpy/numpydoc/issues/485) <https://github.com/numpy/numpydoc/pull/485>__ (mwtoews <https://github.com/mwtoews>__)
  • Generate requirements files from pyproject.toml [#483](https://github.com/numpy/numpydoc/issues/483) <https://github.com/numpy/numpydoc/pull/483>__ (mwtoews <https://github.com/mwtoews>__)
  • Add Source to project.urls table [#480](https://github.com/numpy/numpydoc/issues/480) <https://github.com/numpy/numpydoc/pull/480>__ (mwtoews <https://github.com/mwtoews>__)
  • Align behavior of pre-commit hook and Sphinx extension [#476](https://github.com/numpy/numpydoc/issues/476) <https://github.com/numpy/numpydoc/pull/476>__ (stefmolin <https://github.com/stefmolin>__)
  • Fix dynamic version specification. [#477](https://github.com/numpy/numpydoc/issues/477) <https://github.com/numpy/numpydoc/pull/477>__ (stefmolin <https://github.com/stefmolin>__)
  • Update year [#475](https://github.com/numpy/numpydoc/issues/475) <https://github.com/numpy/numpydoc/pull/475>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Use pyproject.toml [#474](https://github.com/numpy/numpydoc/issues/474) <https://github.com/numpy/numpydoc/pull/474>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Install package on rtd [#472](https://github.com/numpy/numpydoc/issues/472) <https://github.com/numpy/numpydoc/pull/472>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Add token for artifact redirector [#470](https://github.com/numpy/numpydoc/issues/470) <https://github.com/numpy/numpydoc/pull/470>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Use rtd template (old method is deprecated) [#468](https://github.com/numpy/numpydoc/issues/468) <https://github.com/numpy/numpydoc/pull/468>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update doc requirements [#465](https://github.com/numpy/numpydoc/issues/465) <https://github.com/numpy/numpydoc/pull/465>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Update pre-commit hooks [#464](https://github.com/numpy/numpydoc/issues/464) <https://github.com/numpy/numpydoc/pull/464>__ (jarrodmillman <https://github.com/jarrodmillman>__)
  • Drop Python 3.7 [#462](https://github.com/numpy/numpydoc/issues/462) <https://github.com/numpy/numpydoc/pull/462>__ (jarrodmillman <https://github.com/jarrodmillman>__)

... (truncated)

Commits
  • ac7ba53 Designate 1.6.0 release
  • 229a4ff Bump actions/checkout from 3 to 4 (#504)
  • 881c0ab BUG: validator now handles properties (#500)
  • ecd24ab [pre-commit.ci] pre-commit autoupdate (#501)
  • df55b8a BUG: validator now handles decorators (#496)
  • 307992e BUG: Fix clean_backref for extensions that have backrefs to inline elements. ...
  • 6e748ef Bump version
  • ddeba36 Designate 1.6.0rc2 release
  • d9a3dfe TST: Test no-file for source (#493)
  • 41a1508 Use label-check and attach-next-milestone-action (#492)
  • Additional commits viewable in compare view

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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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.6.0.
- [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.6.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants