Repository navigation
Commit 6e6f276
authored
Bump pydoclint from 0.9.1 to 0.11.0 (#1462)
Bumps [pydoclint](https://github.com/jsh9/pydoclint) from 0.9.1 to
0.11.0.
<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.11.0</h2>
<h2>What's Changed</h2>
<ul>
<li>Support checking stub (.pyi) files by <a
href="https://github.com/jsh9"><code>@jsh9</code></a> in <a
href="https://redirect.github.com/jsh9/pydoclint/pull/310">jsh9/pydoclint#310</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/jsh9/pydoclint/compare/0.10.1...0.11.0">https://github.com/jsh9/pydoclint/compare/0.10.1...0.11.0</a></p>
<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.11.0] - 2026-10-02</h2>
<ul>
<li>Added
<ul>
<li>A new config option <code>--include-stub-files</code> (shortform:
<code>-isf</code>, default:
<code>False</code>), so that scanning a folder also checks stub
(<code>.pyi</code>) files (<a
href="https://redirect.github.com/jsh9/pydoclint/issues/303">#303</a>)</li>
</ul>
</li>
<li>Fixed
<ul>
<li>False-positive <code>DOC403</code> and <code>DOC502</code>
violations in stub (<code>.pyi</code>) files,
whose function bodies are placeholders, in both the native mode and
<em>flake8</em> (<a
href="https://redirect.github.com/jsh9/pydoclint/issues/303">#303</a>).
<code>DOC403</code> is still reported in stub files when the return
annotation isn't a Generator/Iterator/Iterable (or is missing), because
then the function can't yield anything</li>
<li>False-positive <code>DOC105</code> and <code>DOC605</code>
violations in stub files when
<code>--check-arg-defaults</code> is <code>True</code>: an argument or
class attribute whose
default is the <code>...</code> placeholder can now be documented with
any default
value or none</li>
<li>False-positive <code>DOC201</code> violations for abstract methods
and stub functions
annotated with <code>Iterator[...]</code> or <code>Iterable[...]</code>
whose docstrings have a
"Yields" section (and no "return" statements in the
body). Their bodies are
placeholders, so the "Yields" section is what shows that they
yield, and
they don't need a "Returns" section</li>
<li>False-positive <code>DOC203</code> violations for abstract methods
and stub functions
annotated with <code>Generator[YieldType, SendType, ReturnType]</code>
whose "Returns"
section documents <code>ReturnType</code>, as for a generator that both
yields and
returns</li>
<li>False-positive <code>DOC202</code> violations for abstract methods
and stub functions
that have a "Returns" section but no return annotation.
(<code>DOC203</code> still
reports the missing annotation when return types are checked.)</li>
<li>A crash (<code>IndexError</code>) when
<code>--check-arg-defaults</code> is <code>True</code> and
positional-only arguments (the ones before <code>/</code>) have default
values. When
it didn't crash, the defaults of positional-only arguments were
ignored</li>
</ul>
</li>
<li>Full diff
<ul>
<li><a
href="https://github.com/jsh9/pydoclint/compare/0.10.1...0.11.0">https://github.com/jsh9/pydoclint/compare/0.10.1...0.11.0</a></li>
</ul>
</li>
</ul>
<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</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/jsh9/pydoclint/commit/24412c5f73ad438a08146132ea86a9a72c8bd5ad"><code>24412c5</code></a>
Support checking stub (.pyi) files (<a
href="https://redirect.github.com/jsh9/pydoclint/issues/310">#310</a>)</li>
<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.11.0">compare
view</a></li>
</ul>
</details>
<br />1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
0 commit comments