Skip to content

Commit e4fc308

Browse files
Bump pydoclint from 0.9.1 to 0.10.1 (#1462)
Bumps [pydoclint](https://github.com/jsh9/pydoclint) from 0.9.1 to 0.10.1. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/jsh9/pydoclint/releases">pydoclint's releases</a>.</em></p> <blockquote> <h2>0.10.1</h2> <h2>What's Changed</h2> <ul> <li>Rewrite README and restructure docs by <a href="https://github.com/jsh9"><code>@​jsh9</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/307">jsh9/pydoclint#307</a></li> <li>Use stacked pytest parametrize instead of itertools.product in tests by <a href="https://github.com/jsh9"><code>@​jsh9</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/308">jsh9/pydoclint#308</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jsh9/pydoclint/compare/0.10.0...0.10.1">https://github.com/jsh9/pydoclint/compare/0.10.0...0.10.1</a></p> <h2>0.10.0</h2> <h2>What's Changed</h2> <ul> <li>Use external changelog diff checking hook by <a href="https://github.com/jsh9"><code>@​jsh9</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/297">jsh9/pydoclint#297</a></li> <li>Add separate options for private, underscore-only, and special dunder names by <a href="https://github.com/jsh9"><code>@​jsh9</code></a> in <a href="https://redirect.github.com/jsh9/pydoclint/pull/306">jsh9/pydoclint#306</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jsh9/pydoclint/compare/0.9.1...0.10.0">https://github.com/jsh9/pydoclint/compare/0.9.1...0.10.0</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md">pydoclint's changelog</a>.</em></p> <blockquote> <h2>[0.10.1] - 2026-09-27</h2> <ul> <li>Changed <ul> <li>Rewrote the README and restructured the docs</li> </ul> </li> <li>Fixed <ul> <li>Stale docs content and the broken <code>DOC103</code>/<code>DOC603</code> docs link</li> </ul> </li> <li>Added <ul> <li><code>docs/llms.txt</code> and a pre-commit check for orphan docs and broken links</li> </ul> </li> <li>Maintenance <ul> <li>Replaced <code>itertools.product</code> with stacked <code>@pytest.mark.parametrize</code> decorators in <code>tests/test_main.py</code></li> </ul> </li> <li>Full diff <ul> <li><a href="https://github.com/jsh9/pydoclint/compare/0.10.0...0.10.1">https://github.com/jsh9/pydoclint/compare/0.10.0...0.10.1</a></li> </ul> </li> </ul> <h2>[0.10.0] - 2026-09-27</h2> <ul> <li>Added <ul> <li><code>--ignore-underscore-only-args</code> (<code>-iuoa</code>, default: <code>True</code>)</li> <li><code>--ignore-special-dunder-args</code> (<code>-isda</code>, default: <code>False</code>)</li> <li><code>--ignore-private-class-attributes</code> (<code>-ipca</code>, default: <code>True</code>)</li> <li><code>--ignore-underscore-only-class-attributes</code> (<code>-iuoca</code>, default: <code>True</code>)</li> <li><code>--ignore-special-dunder-class-attributes</code> (<code>-isdca</code>, default: <code>True</code>)</li> </ul> </li> <li>Fixed <ul> <li>Allowed conventional underscore-only class attribute placeholders, such as <code>_: dataclasses.KW_ONLY</code>, to be ignored independently of private class attributes (<a href="https://redirect.github.com/jsh9/pydoclint/issues/302">#302</a>). This is a name-based fix, so a <code>KW_ONLY</code> pseudo-field whose name is not underscore-only is still treated like any other attribute</li> <li>Accepted Flake8 boolean option values case-insensitively (such as <code>false</code>), so the lowercase values shown in migration messages work in Flake8 config files</li> </ul> </li> <li>Changed <ul> <li>Star arguments are now classified without their leading <code>*</code> or <code>**</code>, so <code>*_</code> and <code>**__</code> are ignored by <code>--ignore-underscore-only-args</code>, and <code>*_args</code> is ignored by <code>--ignore-private-args</code></li> <li><code>--skip-checking-private-functions</code> now also skips functions named <code>__</code> or <code>___</code> (it already skipped <code>_</code>); special dunder methods such as <code>__init__</code> are still checked</li> <li><code>--ignore-private-args</code> no longer controls special dunder arguments (such as <code>__value__</code>). If you set <code>--ignore-private-args=True</code> and want them to stay ignored, also set <code>--ignore-special-dunder-args=True</code></li> <li>Changed the <code>Visitor</code> keyword arguments from <code>ignoreUnderscoreArgs</code> and <code>shouldDocumentPrivateClassAttributes</code> to <code>ignoreUnderscoreOnlyArgs</code>, <code>ignoreSpecialDunderArgs</code>, <code>ignorePrivateClassAttributes</code>, <code>ignoreUnderscoreOnlyClassAttributes</code>, and <code>ignoreSpecialDunderClassAttributes</code>; this is a breaking change for code that uses <code>Visitor</code> directly</li> </ul> </li> <li>Removed <ul> <li>Removed <code>--ignore-underscore-args</code>; using it now fails with guidance to delete it when it has the new default value or replace it with <code>--ignore-underscore-only-args</code></li> </ul> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jsh9/pydoclint/commit/e0aeee36ac994cefd38eefca3d073fcb2154bc76"><code>e0aeee3</code></a> Use stacked pytest parametrize instead of itertools.product in tests (<a href="https://redirect.github.com/jsh9/pydoclint/issues/308">#308</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/f87ba10fa90523310352dd2ccf153690b2271e8d"><code>f87ba10</code></a> Rewrite README and restructure docs (<a href="https://redirect.github.com/jsh9/pydoclint/issues/307">#307</a>)</li> <li><a href="https://github.com/jsh9/pydoclint/commit/4bfdb3cab029a8c56bc0a28f6f04373b8304c274"><code>4bfdb3c</code></a> Add separate options for private, underscore-only, and special dunder names (...</li> <li><a href="https://github.com/jsh9/pydoclint/commit/b72c91f68e0cc3c3838c5dc3a69b992dbe8d4231"><code>b72c91f</code></a> Use external changelog diff checking hook (<a href="https://redirect.github.com/jsh9/pydoclint/issues/297">#297</a>)</li> <li>See full diff in <a href="https://github.com/jsh9/pydoclint/compare/0.9.1...0.10.1">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pydoclint&package-manager=pip&previous-version=0.9.1&new-version=0.10.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 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-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> 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 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) </details>
2 parents 64252b8 + 72f39c2 commit e4fc308

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ dev-flake8 = [
5252
"flake8-datetimez == 26.8.1",
5353
"flake8-docstrings == 1.7.0",
5454
"flake8-pyproject == 1.2.4", # For reading the flake8 config from pyproject.toml
55-
"pydoclint == 0.9.1",
55+
"pydoclint == 0.10.1",
5656
"pydocstyle == 6.3.0",
5757
]
5858
dev-formatting = ["black == 26.5.1", "isort == 9.0.1"]

0 commit comments

Comments
 (0)