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 pydoclint from 0.4.1 to 0.5.3 #63

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps pydoclint from 0.4.1 to 0.5.3.

Release notes

Sourced from pydoclint's releases.

0.5.3

What's Changed

Full Changelog: jsh9/pydoclint@0.5.2...0.5.3

0.5.2

What's Changed

New Contributors

Full Changelog: jsh9/pydoclint@0.5.1...0.5.2

0.5.1

What's Changed

Full Changelog: jsh9/pydoclint@0.5.0...0.5.1

0.5.0

What's Changed

  • Check class attributes against docstring by @​jsh9 in jsh9/pydoclint#130
    • This functionality checks class attributes against the "Attributes" section of the docstring
    • There is a new config option, --check-class-attributes (or -cca), which defaults to True. Therefore, this breaks backward compatibility.
    • To maintain backward compatibility, set --check-class-attributes to False
    • Options like --check-arg-order, --arg-type-hints-in-signature, and --arg-type-hints-in-docstring are still effective in checking class attributes

Full Changelog: jsh9/pydoclint@0.4.2...0.5.0

0.4.2

What's Changed

Full Changelog: jsh9/pydoclint@0.4.1...0.4.2

Changelog

Sourced from pydoclint's changelog.

[0.5.3] - 2024-06-26

[0.5.2] - 2024-06-26

  • Changed

    • Pinned to a higher version (0.0.9) of docstring_parser_fork
    • Relaxed class attribute checking logic
      • When a class has no docstring, no DOC6xx violations will be reported
      • When a class has a short docstring (and --skip-checking-short-docstrings) is set to True, no DOC6xx violations will be reported
  • Full diff

[0.5.1] - 2024-06-24

  • Fixed

    • Fixed a bug in unparsing annotations when checking class attributes
    • Fixed a bug in checking class attributes where there are no attributes in class def or in docstring
  • Changed

    • Used a dedicated "attribute" section for Sphinx-style docstrings
  • Full diff

[0.5.0] - 2024-06-22

  • Added

    • Added checks for class attributes
      • This functionality checks class attributes against the "Attributes" section of the docstring
      • There is a new config option, --check-class-attributes (or -cca), which defaults to True. Therefore, this breaks backward compatibility.
      • To maintain backward compatibility, set --check-class-attributes to False

... (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 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 [pydoclint](https://github.com/jsh9/pydoclint) from 0.4.1 to 0.5.3.
- [Release notes](https://github.com/jsh9/pydoclint/releases)
- [Changelog](https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md)
- [Commits](jsh9/pydoclint@0.4.1...0.5.3)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot requested a review from a team as a code owner July 1, 2024 11:12
@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 Jul 1, 2024
@dependabot dependabot bot requested a review from a team as a code owner July 1, 2024 11:12
@tiyash-basu-frequenz tiyash-basu-frequenz added this pull request to the merge queue Jul 1, 2024
Merged via the queue into v0.x.x with commit c532b2d Jul 1, 2024
16 checks passed
@tiyash-basu-frequenz tiyash-basu-frequenz deleted the dependabot/pip/pydoclint-0.5.3 branch July 1, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant