Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 1, 2024

Bumps the required group with 8 updates:

Package From To
pydoclint 0.5.6 0.5.9
mkdocs-macros-plugin 1.0.5 1.2.0
mkdocs-material 9.5.34 9.5.39
mkdocstrings[python] 0.26.0 0.26.1
mkdocstrings-python 1.10.9 1.11.1
pylint 3.2.7 3.3.1
hypothesis 6.111.2 6.112.2
pytest 8.3.2 8.3.3

Updates pydoclint from 0.5.6 to 0.5.9

Release notes

Sourced from pydoclint's releases.

0.5.9

What's Changed

New Contributors

Full Changelog: jsh9/pydoclint@0.5.8...0.5.9

0.5.8

What's Changed

Full Changelog: jsh9/pydoclint@0.5.7...0.5.8

0.5.7

What's Changed

New Contributors

Full Changelog: jsh9/pydoclint@0.5.6...0.5.7

Changelog

Sourced from pydoclint's changelog.

[0.5.9] - 2024-09-29

[0.5.8] - 2024-09-23

[0.5.7] - 2024-09-02

  • Added

    • A new violation code, DOC503, which checks that exceptions in the function body match those in the "Raises" section of the docstring
  • Changed

    • Switched from tab to 4 spaces in baseline
  • Full diff

Commits
  • 8170436 Improve handling of long type annotations (#173)
  • 27ff769 doc(usage): Including a null-ls use with neovim. (#167)
  • 5e941f5 fix: DOC503 catch namespaced exceptions (#168)
  • f758604 feat: introduce DOC503 for checking specific raised exceptions (#161)
  • ae28589 Switch from tab to 4 spaces in baseline (#152)
  • 1e80fd3 tox: use deps = . instead of pip install (#160)
  • 23b89f6 docs: add "sphinx" as an allowed style (#159)
  • See full diff in compare view

Updates mkdocs-macros-plugin from 1.0.5 to 1.2.0

Changelog

Sourced from mkdocs-macros-plugin's changelog.

1.2.0, 2024-09-15

  • Added: three hooks register_variables/macros/filters to facilitate cooperation with other MkDocs plugins.
  • Fixed: `define_env() was always required in module (#191)
  • Added: trace the case when no module is found (INFO)
  • Improved documentation, particularly about HTML pages
  • Added: parameters j2_comment_start_string and j2_comment_end_string to plugin's parameters, to specify alternate markers for comments.
  • Added the multiline parameter force_render_paths in the config file, to specify directories or file patterns to be rendered for the case when render_by_default = false (the render_macros parameter in the YAML header of the page has the last word).
Commits
  • e8b3f45 Document hooks for #237 (register macros/variables/filters)
  • c1029d5 Document how to correct issue with macros / admonitions (#240)
  • 67ccb15 Merge pull request #238 from timvink/master
  • 03f5e89 Fix registration system
  • ddace97 remove property on register methods
  • 363d904 Add three hooks register_variables/macros/filters (#237)
  • 2fb833e Improved implementation for relative url (#236)
  • 69e7cad Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master
  • 5bec964 Add standard filter normalize_url (#236)
  • 9a08f11 Merge pull request #228 from caomingpei/master
  • Additional commits viewable in compare view

Updates mkdocs-material from 9.5.34 to 9.5.39

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.5.39

  • Fixed #7226: not staying on page when using mike's canonical versioning

Thanks go to @​ilyagr for their contributions

mkdocs-material-9.5.38

  • Added Albanian translations

Thanks go to @​gerardkraja for their contributions

mkdocs-material-9.5.37

  • Added 4th and 5th level ordered list styles
  • Fixed #7548: Tags have no spacing in search

mkdocs-material-9.5.36

  • Fixed #7544: Social cards incorrectly rendering HTML entities
  • Fixed #7542: Improved support for setting custom list styles

mkdocs-material-9.5.35

  • Fixed #7498: Search not showing for Vietnamese language
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.5.39+insiders-4.53.14 (2024-09-29)

  • Fixed #7567: Empty headlines when using typeset plugin with anchorlinks

mkdocs-material-9.5.39 (2024-09-29)

  • Fixed #7226: not staying on page when using mike's canonical versioning

mkdocs-material-9.5.38 (2024-09-26)

  • Added Albanian translations

mkdocs-material-9.5.37 (2024-09-25)

  • Added 4th and 5th level ordered list styles
  • Fixed #7548: Tags have no spacing in search

mkdocs-material-9.5.36 (2024-09-21)

  • Fixed #7544: Social cards incorrectly rendering HTML entities
  • Fixed #7542: Improved support for setting custom list styles

mkdocs-material-9.5.35 (2024-09-18)

  • Fixed #7498: Search not showing for Vietnamese language

mkdocs-material-9.5.34+insiders-4.53.13 (2024-09-14)

  • Fixed #7520: Social plugin errors for generated files (MkDocs 1.6+)

mkdocs-material-9.5.34 (2024-08-31)

  • Updated Mermaid.js to version 11 (latest)

mkdocs-material-9.5.33 (2024-08-23)

  • Fixed #7453: Incorrect position of tooltip when sorting table

mkdocs-material-9.5.32 (2024-08-19)

  • Fixed RXSS vulnerability via deep link in search results
  • Added support for fetching latest release from GitLab

mkdocs-material-9.5.31+insiders-4.53.12 (2024-08-02)

  • Fixed #7410: Instant previews jump on content tabs with anchor links
  • Fixed #7408: Instant previews jump on content tabs

mkdocs-material-9.5.31 (2024-08-02)

... (truncated)

Commits

Updates mkdocstrings[python] from 0.26.0 to 0.26.1

Release notes

Sourced from mkdocstrings[python]'s releases.

0.26.1

0.26.1 - 2024-09-06

Compare with 0.26.0

Bug Fixes

  • Instantiate config of the autorefs plugin when it is not enabled by the user (db2ab34 by Timothée Mazzucotelli). Issue-autorefs#57
Changelog

Sourced from mkdocstrings[python]'s changelog.

0.26.1 - 2024-09-06

Compare with 0.26.0

Bug Fixes

  • Instantiate config of the autorefs plugin when it is not enabled by the user (db2ab34 by Timothée Mazzucotelli). Issue-autorefs#57
Commits
  • 651d176 chore: Prepare release 0.26.1
  • db2ab34 fix: Instantiate config of the autorefs plugin when it is not enabled by the ...
  • a65035a docs: Clarify that Installation section
  • See full diff in compare view

Updates mkdocstrings-python from 1.10.9 to 1.11.1

Release notes

Sourced from mkdocstrings-python's releases.

1.11.1

1.11.1 - 2024-09-03

Compare with 1.11.0

Code Refactoring

  • Prepare relative_crossrefs and scoped_crossrefs insiders features (dd8b014 by Timothée Mazzucotelli).

1.11.0

1.11.0 - 2024-09-03

Compare with 1.10.9

Features

  • Hook into autorefs to provide context around cross-ref errors (bb4be5b by Timothée Mazzucotelli).
Changelog

Sourced from mkdocstrings-python's changelog.

1.11.1 - 2024-09-03

Compare with 1.11.0

Code Refactoring

  • Prepare relative_crossrefs and scoped_crossrefs insiders features (dd8b014 by Timothée Mazzucotelli).

1.11.0 - 2024-09-03

Compare with 1.10.9

Features

  • Hook into autorefs to provide context around cross-ref errors (bb4be5b by Timothée Mazzucotelli).
Commits
  • 6dafa9a chore: Prepare release 1.11.1
  • dd8b014 refactor: Prepare relative_crossrefs and scoped_crossrefs insiders features
  • 7b11ba8 docs: Update docs from insiders
  • 446d725 chore: Prepare release 1.11.0
  • bb4be5b feat: Hook into autorefs to provide context around cross-ref errors
  • See full diff in compare view

Updates pylint from 3.2.7 to 3.3.1

Commits

Updates hypothesis from 6.111.2 to 6.112.2

Commits
  • 83c22d9 Bump hypothesis-python version to 6.112.2 and update changelog
  • 3c1350d Merge pull request #4119 from HypothesisWorks/create-pull-request/patch
  • 2958a45 Fix for cyclic exception context
  • 75650b9 Merge pull request #4061 from abeakkas/fix-assume-example
  • 7fdad0b Update pinned dependencies
  • 879225d Merge pull request #4112 from HypothesisWorks/create-pull-request/patch
  • bd8e963 Update pinned dependencies
  • 4d079f7 Merge pull request #4104 from Zac-HD/update-deps
  • 1caa0f2 drop win py39 CI
  • f81af9c Update pinned deps
  • Additional commits viewable in compare view

Updates pytest from 8.3.2 to 8.3.3

Release notes

Sourced from pytest's releases.

8.3.3

pytest 8.3.3 (2024-09-09)

Bug fixes

  • #12446: Avoid calling @property (and other instance descriptors) during fixture discovery -- by asottile{.interpreted-text role="user"}

  • #12659: Fixed the issue of not displaying assertion failure differences when using the parameter --import-mode=importlib in pytest>=8.1.

  • #12667: Fixed a regression where type change in [ExceptionInfo.errisinstance]{.title-ref} caused [mypy]{.title-ref} to fail.

  • #12744: Fixed typing compatibility with Python 3.9 or less -- replaced [typing.Self]{.title-ref} with [typing_extensions.Self]{.title-ref} -- by Avasam{.interpreted-text role="user"}

  • #12745: Fixed an issue with backslashes being incorrectly converted in nodeid paths on Windows, ensuring consistent path handling across environments.

  • #6682: Fixed bug where the verbosity levels where not being respected when printing the "msg" part of failed assertion (as in assert condition, msg).

  • #9422: Fix bug where disabling the terminal plugin via -p no:terminal would cause crashes related to missing the verbose option.

    -- by GTowers1{.interpreted-text role="user"}

Improved documentation

  • #12663: Clarify that the [pytest_deselected]{.title-ref} hook should be called from [pytest_collection_modifyitems]{.title-ref} hook implementations when items are deselected.
  • #12678: Remove erroneous quotes from [tmp_path_retention_policy]{.title-ref} example in docs.

Miscellaneous internal changes

  • #12769: Fix typos discovered by codespell and add codespell to pre-commit hooks.
Commits

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 <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Bumps the required group with 8 updates:

| Package | From | To |
| --- | --- | --- |
| [pydoclint](https://github.com/jsh9/pydoclint) | `0.5.6` | `0.5.9` |
| [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) | `1.0.5` | `1.2.0` |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.34` | `9.5.39` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.26.0` | `0.26.1` |
| [mkdocstrings-python](https://github.com/mkdocstrings/python) | `1.10.9` | `1.11.1` |
| [pylint](https://github.com/pylint-dev/pylint) | `3.2.7` | `3.3.1` |
| [hypothesis](https://github.com/HypothesisWorks/hypothesis) | `6.111.2` | `6.112.2` |
| [pytest](https://github.com/pytest-dev/pytest) | `8.3.2` | `8.3.3` |


Updates `pydoclint` from 0.5.6 to 0.5.9
- [Release notes](https://github.com/jsh9/pydoclint/releases)
- [Changelog](https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md)
- [Commits](jsh9/pydoclint@0.5.6...0.5.9)

Updates `mkdocs-macros-plugin` from 1.0.5 to 1.2.0
- [Release notes](https://github.com/fralau/mkdocs_macros_plugin/releases)
- [Changelog](https://github.com/fralau/mkdocs-macros-plugin/blob/master/CHANGELOG.md)
- [Commits](fralau/mkdocs-macros-plugin@v1.0.5...v1.2.0)

Updates `mkdocs-material` from 9.5.34 to 9.5.39
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.34...9.5.39)

Updates `mkdocstrings[python]` from 0.26.0 to 0.26.1
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.26.0...0.26.1)

Updates `mkdocstrings-python` from 1.10.9 to 1.11.1
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.10.9...1.11.1)

Updates `pylint` from 3.2.7 to 3.3.1
- [Release notes](https://github.com/pylint-dev/pylint/releases)
- [Commits](pylint-dev/pylint@v3.2.7...v3.3.1)

Updates `hypothesis` from 6.111.2 to 6.112.2
- [Release notes](https://github.com/HypothesisWorks/hypothesis/releases)
- [Commits](HypothesisWorks/hypothesis@hypothesis-python-6.111.2...hypothesis-python-6.112.2)

Updates `pytest` from 8.3.2 to 8.3.3
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](pytest-dev/pytest@8.3.2...8.3.3)

---
updated-dependencies:
- dependency-name: pydoclint
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: mkdocs-macros-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: mkdocstrings[python]
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: pylint
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: hypothesis
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: pytest
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested a review from a team as a code owner October 1, 2024 23:56
@dependabot dependabot bot requested a review from Marenz October 1, 2024 23:56
@dependabot dependabot bot added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users labels Oct 1, 2024
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are new checks performed by pydoclint for exceptions that are present in the Raises: docs and not it the code. Some might need a doc update (because the code is not really raising them) and some might need a # noqa: DOC503 (if the exception is being raised indirectly by another function we are calling). We need to see on a case-by-case basis.

llucax added 5 commits October 9, 2024 10:51
There is a new check in `pydoclint` that checks all exceptions in the
docs are actually raised directly in the function body, but we sometimes
want to document exceptions raised indirectly too.

Signed-off-by: Leandro Lucarella <[email protected]>
Some tools are not smart enough to do proper semantic analysis. That is
the case for `pydoclint`, so it can't figure out that
`_receiver.ReceiverStoppedError` is what we want to document. To make
things simpler we just import the individual symbols to the top-level
namespace.

Signed-off-by: Leandro Lucarella <[email protected]>
`pylint` doesn't like calling dunder methods explicitly and `anext()`
was added in Python 3.10. Since we depend on Python 3.11 we can just use
`anext()` and make `pylint` happy.

Signed-off-by: Leandro Lucarella <[email protected]>
This rule is now disabled globally, as it is already checked by `mypy`
and `pylint` have some false positives, like this one.

Signed-off-by: Leandro Lucarella <[email protected]>
@github-actions github-actions bot added part:channels Affects channels implementation part:synchronization Affects the synchronization of multiple sources (`select`, `merge`) part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.) part:utilities Affects the utility receivers (`Timer`, `Event`, `FileWatcher`) labels Oct 9, 2024
llucax
llucax previously approved these changes Oct 9, 2024
Copy link
Contributor

@llucax llucax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to fix the failing new checks.

@llucax llucax added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Oct 9, 2024
@llucax
Copy link
Contributor

llucax commented Oct 9, 2024

Self-merging as this should be uncontroversial.

@llucax llucax merged commit f92e1ef into v1.x.x Oct 9, 2024
16 checks passed
@llucax llucax self-assigned this Oct 9, 2024
@llucax llucax deleted the dependabot/pip/required-1596ec9b67 branch October 9, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmd:skip-release-notes It is not necessary to update release notes for this PR part:channels Affects channels implementation part:core Affects the core types (`Sender`, `Receiver`, exceptions, etc.) part:synchronization Affects the synchronization of multiple sources (`select`, `merge`) part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) part:utilities Affects the utility receivers (`Timer`, `Event`, `FileWatcher`) type:tech-debt Improves the project without visible changes for users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants