Skip to content

Clarify docstring in use_ruff #1189

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.

Sign up for GitHub

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

Merged
nathanjmcdougall merged 2 commits into from
Dec 19, 2025
Merged

Clarify docstring in use_ruff #1189

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9caf36e
Clarify docstring in `use_ruff`
nathanjmcdougall Dec 19, 2025
1e4739e
Merge branch 'main' into feature/use-ruff
nathanjmcdougall Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/usethis/_core/tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,10 +417,12 @@ def use_ruff(
) -> None:
"""Add Ruff to the project.

By default, sensible default rules are selected. The exceptions are when using the
`minimal` option, or if rules are already selected, in which case they are left
alone. However, if the existing rules are all pydocstyle rules (managed by the
`usethis docstyle` interface, then the default rules will still be added).
By default, sensible default rules are selected if there are no rules selected yet,
but this behaviour can be controlled by using the `minimal` option.

If the existing rules are all pydocstyle rules (managed by the `usethis docstyle`
interface), then the default rules will still be added, again excepting when the
`minimal` option is used.

Args:
remove: Remove Ruff configuration.
Expand Down Expand Up @@ -494,6 +496,9 @@ def use_ruff(

def _get_basic_rule_config() -> RuleConfig:
"""Get the basic rule config for Ruff."""
# This is not merged with existing config; it's a sensible default set of rules if
# starting from nothing. See the `use_ruff()` docstring.

rule_config = RuleConfig(
selected=[
"A",
Expand Down