1.11.0rc0#

We’re happy to announce the release of numpydoc 1.11.0rc0!

Enhancements#

  • Remove spaces resulting from line continuation in arg type descriptor (#676).

  • Make numpydoc lint --ignore ... parsing more robust (#560).

Bug Fixes#

  • fix: resolve numpydoc StopIteration error for async functions (#675).

  • fix: handle Sphinx 9.x new autodoc options key format and sentinels (#688).

  • GL01 catches valid docstring example (#574).

  • Dedent section starting with .. deprecation:: (#575).

Documentation#

  • Add 1.10.0 release notes (#696).

Maintenance#

  • MAINT: Bump to dev (#672).

  • TST,CI: Add workflow to check sdist (#670).

  • Bump the actions group with 3 updates (#673).

  • [pre-commit.ci] pre-commit autoupdate (#674).

  • Bump the actions group with 2 updates (#680).

  • Bump actions/download-artifact from 8.0.0 to 8.0.1 in the actions group (#681).

  • [pre-commit.ci] pre-commit autoupdate (#682).

  • Bump the actions group with 2 updates (#685).

  • Add sphinx8 to oldsphinx testing matrix (#689).

  • Update classifiers to show 3.14 support (#695).

Contributors#

7 authors added to this release (alphabetically):

7 reviewers added to this release (alphabetically):

_These lists are automatically generated, and may not be complete or may contain duplicates._

1.10.0#

We’re happy to announce the release of numpydoc 1.10.0!

Enhancements#

  • Added “exclude_files” option for pyproject.toml config usage (#635).

  • Constructor checking for AST validator (#622).

Bug Fixes#

  • FIX: account for unreleased changes to sphinx (#649).

Documentation#

  • Fix circleci doc buld (#634).

Maintenance#

  • Bump the actions group across 1 directory with 3 updates (#644).

  • build(pyproject.toml): drop support for python 3.9 (require 3.10+) (#641).

  • [pre-commit.ci] pre-commit autoupdate (#639).

  • MAINT: Make pre-commit run –all pass (#650).

  • Remove duplicate dependency in pyproject.toml (#654).

  • TST: A few minor test improvements (#652).

  • Fix test warnings about invalid regex escape (#655).

  • Bump the actions group with 3 updates (#647).

  • Bump the actions group with 2 updates (#657).

  • MAINT: rm unused kwarg from private method (#658).

  • Fix pytest warning regression by switching to re.escape() (#660).

  • CI version updates (#662).

  • Bump actions/checkout from 5 to 6 in the actions group (#666).

  • More CI updates (#663).

  • MAINT: Prep for v1.10.0 (#667).

Contributors#

7 authors added to this release (alphabetically):

8 reviewers added to this release (alphabetically):

_These lists are automatically generated, and may not be complete or may contain duplicates._

1.9.0#

We’re happy to announce the release of numpydoc 1.9.0!

Enhancements#

  • ignore some errors at module level (#593).

  • Rework hook output to remove the table (#611).

  • Switch to storing AST nodes on the stack for more accurate method signature check and easy access to parent nodes (#623).

Bug Fixes#

  • MAINT: Changed class constructor __init__ GL08 reporting (#592).

  • BUG: Correct functionality of numpydoc SS05 (#613).

  • Specity the types of numpydoc_xref_ignore option (#631).

Documentation#

  • DOC: Do not use types for *args, **kwargs (#585).

  • mention conda-forge in installation docs (#595).

  • Fix typo in validation.rst (#605).

  • Fix broken link in format.rst (#628).

Maintenance#

  • CI: use hashes for actions’ versions in publishing job (#579).

  • Bump the actions group with 2 updates (#581).

  • Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.2 in the actions group (#582).

  • [pre-commit.ci] pre-commit autoupdate (#583).

  • MAINT: Add _exception_on_warning to MockApp (#586).

  • Bump the actions group across 1 directory with 2 updates (#590).

  • don’t pass maxsplit as positional arg (#596).

  • [pre-commit.ci] pre-commit autoupdate (#598).

  • Add Python 3.13 support (#599).

  • Update readthedocs config (#600).

  • Bump the actions group with 2 updates (#603).

  • Bump the actions group with 3 updates (#609).

  • [pre-commit.ci] pre-commit autoupdate (#614).

  • Bump actions/download-artifact from 4.2.1 to 4.3.0 in the actions group (#620).

  • Bump scientific-python/circleci-artifacts-redirector-action from 1.0.0 to 1.1.0 in the actions group (#627).

  • Switch to dependency groups (#626).

  • Fix pip setup command in github workflow (#629).

Contributors#

13 authors added to this release (alphabetically):

7 reviewers added to this release (alphabetically):

_These lists are automatically generated, and may not be complete or may contain duplicates._

1.8.0#

We’re happy to announce the release of numpydoc 1.8.0!

Enhancements#

  • Unify CLIs (#537).

  • Move “Attributes” and “Methods” below “Parameters” (#571).

Bug Fixes#

  • FIX: coroutines can have a return statement (#542).

  • Unwrap decorated objects for YD01 validation check (#541).

  • Fix bug with validation encoding (#550).

Documentation#

  • Classify development status as Production/Stable (#548).

  • Add note about TOML regex; fix typo (#552).

  • DOC: Clarify recommendations regarding use of backticks (#525).

Maintenance#

  • Fix typo in label-check.yml (#538).

  • [pre-commit.ci] pre-commit autoupdate (#539).

  • DEV: Rm xfails from pytest summary (#540).

  • Drop Python 3.8 support (#545).

  • Clean up old sphinx cruft (#549).

  • Test on sphinx 7.3 (#547).

  • Require GHA update grouping (#553).

  • Update pre-commit config (#554).

  • Use ruff for linting and formatting (#555).

  • Use intersphinx registry to avoid out of date links (#563).

  • Do not rely on requirements.txt in ci, use .[test,doc] (#566).

  • CI: update action that got moved org (#567).

  • Fix navbar for documentation pages (#569).

  • [pre-commit.ci] pre-commit autoupdate (#570).

  • docscrape: fixes from SciPy (#576).

  • MAINT: Remove scale to work around PyPI bug (#578).

Contributors#

10 authors added to this release (alphabetically):

7 reviewers added to this release (alphabetically):

_These lists are automatically generated, and may not be complete or may contain duplicates._

1.7.0#

We’re happy to announce the release of numpydoc 1.7.0!

Enhancements#

  • PERF: wrap inspect.getsourcelines with cache (#532).

Bug Fixes#

  • during tokenize, use UTF8 encoding on all platforms (#510).

  • fix ‘Alias for field number X’ problem with NamedTuples (#527).

Documentation#

  • DOC: Fix typos found by codespell (#514).

  • DOC: Update link to mailing list (#518).

  • Add Python 3.12 to classifiers (#529).

  • Update release process (#534).

  • Update release process (#535).

Maintenance#

  • [pre-commit.ci] pre-commit autoupdate (#508).

  • [pre-commit.ci] pre-commit autoupdate (#513).

  • MAINT: apply refurb suggestion (#515).

  • [pre-commit.ci] pre-commit autoupdate (#516).

  • Bump actions/setup-python from 4 to 5 (#520).

  • [pre-commit.ci] pre-commit autoupdate (#521).

  • Filter DeprecationWarning in failing test for python 3.12 (#523).

  • MAINT: Replace NameConstant with Constant (#524).

  • [pre-commit.ci] pre-commit autoupdate (#526).

  • Update precommit repos (#531).

  • Require sphinx 6 (#530).

  • Use trusted publisher (#533).

Contributors#

8 authors added to this release (alphabetically):

9 reviewers added to this release (alphabetically):

_These lists are automatically generated, and may not be complete or may contain duplicates._