Unify positional and keyword arguments when checking for missing arguments in docstring #4067
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evanrittenhouse
changed the title
PR Check ResultsEcosystemℹ️ ecosystem check detected changes. (+4, -3, 0 error(s)) bokeh (+3, -3)
- src/bokeh/application/application.py:90:9: D417 Missing argument description in the docstring: `metadata`
+ src/bokeh/application/handlers/server_lifecycle.py:57:9: D417 Missing argument description in the docstring: `package`
+ src/bokeh/application/handlers/server_request_handler.py:59:9: D417 Missing argument description in the docstring: `package`
- src/bokeh/core/enums.py:198:5: D417 Missing argument descriptions in the docstring: `case_sensitive`, `quote`
+ src/bokeh/models/plots.py:124:9: D417 Missing argument description in the docstring: `*args`
- src/bokeh/models/plots.py:124:9: D417 Missing argument descriptions in the docstring: `**kwargs`, `*args`zulip (+1, -0)
+ zerver/lib/tex.py:11:5: D417 Missing argument descriptions in the docstring: `is_inline`, `tex`BenchmarkLinuxWindows |
evanrittenhouse
force-pushed
the
4047_docs_kwargs
branch
from
4925cca
to
c62222a
Compare
evanrittenhouse
force-pushed
the
4047_docs_kwargs
branch
from
72b73ca
to
d43fa72
Compare
evanrittenhouse
changed the title
evanrittenhouse
changed the title
evanrittenhouse
force-pushed
the
4047_docs_kwargs
branch
from
7ab6dd7
to
77f145e
Compare
charliermarsh
added
bug
renovate bot
added a commit
to ixm-one/pytest-cmake-presets
that referenced
this pull request
Apr 25, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://github.com/charliermarsh/ruff) | `^0.0.262` -> `^0.0.263` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.263`](https://github.com/charliermarsh/ruff/releases/tag/v0.0.263) [Compare Source](https://github.com/charliermarsh/ruff/compare/v0.0.262...v0.0.263) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Rules - \[`flake8-bugbear`] Add `pytest.raises(Exception)` support to B017 by [@​alanhdu](https://github.com/alanhdu) in [astral-sh/ruff#4052 - \[`flake8-import-conventions`] Implement new rule `ICN003` to ban `from ... import ...` for selected modules by [@​edgarrmondragon](https://github.com/edgarrmondragon) in [astral-sh/ruff#4040 - \[`pylint`] Implement PLE0302 `unexpected-special-method-signature` by [@​mccullocht](https://github.com/mccullocht) in [astral-sh/ruff#4075 - \[`pep8-naming`] Ignore `N815` for `TypedDict` fields by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4066 ##### Bug Fixes - Avoid `PYI015` for valid default value without annotation by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4043 - Avoid infinite-propagation of inline comments when force-splitting imports by [@​charliermarsh](https://github.com/charliermarsh) in [astral-sh/ruff#4074 - Fix SIM222 and SIM223 false positives and auto-fix by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4063 - Unify positional and keyword arguments when checking for missing arguments in docstring by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4067 - Avoid `RUF008` if field annotation is immutable by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4039 - Increment priority should be (branch-local, global) by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4070 - Ignore `ClassVar` annotation for `RUF008`, `RUF009` by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4081 - Support --fix in watch mode by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4035 #### New Contributors - [@​alanhdu](https://github.com/alanhdu) made their first contribution in [astral-sh/ruff#4052 - [@​pronoym99](https://github.com/pronoym99) made their first contribution in [astral-sh/ruff#4055 - [@​Secrus](https://github.com/Secrus) made their first contribution in [astral-sh/ruff#4085 - [@​madkinsz](https://github.com/madkinsz) made their first contribution in [astral-sh/ruff#4084 - [@​mccullocht](https://github.com/mccullocht) made their first contribution in [astral-sh/ruff#4075 **Full Changelog**: astral-sh/ruff@v0.0.262...v0.0.263 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS41OC4yIiwidXBkYXRlZEluVmVyIjoiMzUuNTguMiJ9--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
renovate bot
added a commit
to allenporter/flux-local
that referenced
this pull request
Apr 27, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://github.com/charliermarsh/ruff) | `==0.0.262` -> `==0.0.263` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.263`](https://github.com/charliermarsh/ruff/releases/tag/v0.0.263) [Compare Source](https://github.com/charliermarsh/ruff/compare/v0.0.262...v0.0.263) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Rules - \[`flake8-bugbear`] Add `pytest.raises(Exception)` support to B017 by [@​alanhdu](https://github.com/alanhdu) in [astral-sh/ruff#4052 - \[`flake8-import-conventions`] Implement new rule `ICN003` to ban `from ... import ...` for selected modules by [@​edgarrmondragon](https://github.com/edgarrmondragon) in [astral-sh/ruff#4040 - \[`pylint`] Implement PLE0302 `unexpected-special-method-signature` by [@​mccullocht](https://github.com/mccullocht) in [astral-sh/ruff#4075 - \[`pep8-naming`] Ignore `N815` for `TypedDict` fields by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4066 ##### Bug Fixes - Avoid `PYI015` for valid default value without annotation by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4043 - Avoid infinite-propagation of inline comments when force-splitting imports by [@​charliermarsh](https://github.com/charliermarsh) in [astral-sh/ruff#4074 - Fix SIM222 and SIM223 false positives and auto-fix by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4063 - Unify positional and keyword arguments when checking for missing arguments in docstring by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4067 - Avoid `RUF008` if field annotation is immutable by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4039 - Increment priority should be (branch-local, global) by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4070 - Ignore `ClassVar` annotation for `RUF008`, `RUF009` by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4081 - Support --fix in watch mode by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4035 #### New Contributors - [@​alanhdu](https://github.com/alanhdu) made their first contribution in [astral-sh/ruff#4052 - [@​pronoym99](https://github.com/pronoym99) made their first contribution in [astral-sh/ruff#4055 - [@​Secrus](https://github.com/Secrus) made their first contribution in [astral-sh/ruff#4085 - [@​madkinsz](https://github.com/madkinsz) made their first contribution in [astral-sh/ruff#4084 - [@​mccullocht](https://github.com/mccullocht) made their first contribution in [astral-sh/ruff#4075 **Full Changelog**: astral-sh/ruff@v0.0.262...v0.0.263 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS41OC4yIiwidXBkYXRlZEluVmVyIjoiMzUuNTguMiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot
added a commit
to allenporter/pyrainbird
that referenced
this pull request
Apr 27, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://github.com/charliermarsh/ruff) | `==0.0.262` -> `==0.0.263` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.263`](https://github.com/charliermarsh/ruff/releases/tag/v0.0.263) [Compare Source](https://github.com/charliermarsh/ruff/compare/v0.0.262...v0.0.263) <!-- Release notes generated using configuration in .github/release.yml at main --> ##### What's Changed ##### Rules - \[`flake8-bugbear`] Add `pytest.raises(Exception)` support to B017 by [@​alanhdu](https://github.com/alanhdu) in [astral-sh/ruff#4052 - \[`flake8-import-conventions`] Implement new rule `ICN003` to ban `from ... import ...` for selected modules by [@​edgarrmondragon](https://github.com/edgarrmondragon) in [astral-sh/ruff#4040 - \[`pylint`] Implement PLE0302 `unexpected-special-method-signature` by [@​mccullocht](https://github.com/mccullocht) in [astral-sh/ruff#4075 - \[`pep8-naming`] Ignore `N815` for `TypedDict` fields by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4066 ##### Bug Fixes - Avoid `PYI015` for valid default value without annotation by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4043 - Avoid infinite-propagation of inline comments when force-splitting imports by [@​charliermarsh](https://github.com/charliermarsh) in [astral-sh/ruff#4074 - Fix SIM222 and SIM223 false positives and auto-fix by [@​JonathanPlasse](https://github.com/JonathanPlasse) in [astral-sh/ruff#4063 - Unify positional and keyword arguments when checking for missing arguments in docstring by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4067 - Avoid `RUF008` if field annotation is immutable by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4039 - Increment priority should be (branch-local, global) by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4070 - Ignore `ClassVar` annotation for `RUF008`, `RUF009` by [@​dhruvmanila](https://github.com/dhruvmanila) in [astral-sh/ruff#4081 - Support --fix in watch mode by [@​evanrittenhouse](https://github.com/evanrittenhouse) in [astral-sh/ruff#4035 ##### New Contributors - [@​alanhdu](https://github.com/alanhdu) made their first contribution in [astral-sh/ruff#4052 - [@​pronoym99](https://github.com/pronoym99) made their first contribution in [astral-sh/ruff#4055 - [@​Secrus](https://github.com/Secrus) made their first contribution in [astral-sh/ruff#4085 - [@​madkinsz](https://github.com/madkinsz) made their first contribution in [astral-sh/ruff#4084 - [@​mccullocht](https://github.com/mccullocht) made their first contribution in [astral-sh/ruff#4075 **Full Changelog**: astral-sh/ruff@v0.0.262...v0.0.263 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/pyrainbird). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS41OC4yIiwidXBkYXRlZEluVmVyIjoiMzUuNTguMiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4047.
We were previously at risk of false positives when an argument was specified in the
Argumentssection and not inKeyword Arguments, or vice versa. Rather than checking arguments on a section-by-section basis, this PR combines positional and keyword arguments into one set then checks that superset against the function signature.It also adds
Other Params/Other Args/Other Argumentsidentifiers to theSectionKindenum.