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.4 #404

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps pydoclint from 0.4.1 to 0.5.4.

Release notes

Sourced from pydoclint's releases.

0.5.4

What's Changed

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

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

... (truncated)

Changelog

Sourced from pydoclint's changelog.

[0.5.4] - 2024-07-14

  • Added
    • An option --should-document-private-class-attributes (if False, private class attributes should not appear in the docstring)
    • An option --treat-property-methods-as-class-attributes (if True, @property methods are treated like class attributes and need to be documented in the class docstring)

[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

... (truncated)

Commits
  • 0b750d5 Add option to treat property methods as class attributes (#153)
  • 3c39d2e Add an option for private class attributes (#149)
  • 98f7a5c Add DOC604 & 605 test cases; improve DOC605 err msg (#147)
  • 4d0293a Don't report DOC109 if arg list is empty (#146)
  • 4dd1667 Don't report DOC6xx if no docstring or short docstring (#145)
  • 457a559 Switch to pprint for Doc objects
  • bf674fa Make url a proper link (#137)
  • 1a270b0 Add DOC6xx explanations to docs
  • f43a961 Use "attribute" docstring section in Sphinx style (#136)
  • 63bed6b Fix another bug in class attr checking (#133)
  • 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 [pydoclint](https://github.com/jsh9/pydoclint) from 0.4.1 to 0.5.4.
- [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.4)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jul 15, 2024
@github-actions github-actions bot enabled auto-merge July 15, 2024 06:39
Copy link
Contributor Author

dependabot bot commented on behalf of github Jul 22, 2024

Superseded by #409.

@dependabot dependabot bot closed this Jul 22, 2024
auto-merge was automatically disabled July 22, 2024 06:29

Pull request was closed

@dependabot dependabot bot deleted the dependabot/pip/pydoclint-0.5.4 branch July 22, 2024 06:29
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.

0 participants