Skip to content

Add missing config docstrings - #15803

Merged
dhruvmanila merged 2 commits into
astral-sh:mainfrom
mishamsk:4551-add-missing-config-docstrings
Jan 29, 2025
Merged

dhruvmanila merged 2 commits into
astral-sh:mainfrom
mishamsk:4551-add-missing-config-docstrings

Conversation

@mishamsk

Copy link
Copy Markdown
Contributor

Summary

As promised in #15603 - the highly sophisticated change - adding missing config docstrings that are used in command completions.

Test Plan

I actually made a local change to emit all empty items and verified there are none now, before opening the PR.

@mishamsk

Copy link
Copy Markdown
Contributor Author

@dhruvmanila as promised!

@github-actions

Copy link
Copy Markdown
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@dhruvmanila dhruvmanila left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

This will also be used in the documentation similar to how there's a "Configures Ruff's analyze command" in https://docs.astral.sh/ruff/settings/#analyze.

@dhruvmanila dhruvmanila added the documentation Improvements or additions to public-facing documentation label Jan 29, 2025
@dhruvmanila
dhruvmanila merged commit 6090408 into astral-sh:main Jan 29, 2025
@mishamsk
mishamsk deleted the 4551-add-missing-config-docstrings branch January 29, 2025 03:39
dcreager added a commit that referenced this pull request Jan 29, 2025
* main:
  [red-knot] Extend instance-attribute tests (#15808)
  Fix formatter warning message for `flake8-quotes` option (#15788)
  [`flake8-bugbear`] Exempt `NewType` calls where the original type is immutable (`B008`) (#15765)
  Add missing config docstrings (#15803)
  [`refurb`] Do not emit diagnostic when loop variables are used outside loop body (`FURB122`) (#15757)
  [`ruff`] Check for shadowed `map` before suggesting fix (`RUF058`) (#15790)
  [red-knot] Do not use explicit `knot_extensions.Unknown` declaration (#15787)
  Preserve quotes in generated byte strings (#15778)
  [minor] Simplify some `ExprStringLiteral` creation logic (#15775)
  Preserve quote style in generated code (#15726)
  Rename internal helper functions (#15771)
  [`airflow`] Extend airflow context parameter check for `BaseOperator.execute` (`AIR302`) (#15713)
  Implement tab autocomplete for `ruff config` (#15603)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to public-facing documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants