Skip to content

Fix doc for Neovim setting examples - #18491

Merged
dhruvmanila merged 1 commit into
astral-sh:mainfrom
shimies:fix-docs-for-nvim-settings
Jun 6, 2025
Merged

dhruvmanila merged 1 commit into
astral-sh:mainfrom
shimies:fix-docs-for-nvim-settings

Conversation

@shimies

@shimies shimies commented Jun 6, 2025

Copy link
Copy Markdown
Contributor

Summary

This PR fixes an error in the example Neovim configuration on this documentation page.
The configuration block should be nested under settings, consistent with other properties and as outlined here.

I encountered this issue when copying the example to configure ruff integration in my neovim - the config didn’t work until I corrected the nesting.

Test Plan

  • Confirmed that the corrected configuration works in a real Neovim + Ruff setup
  • Verified that the updated configuration renders correctly in MkDocs
image

@dhruvmanila dhruvmanila added the documentation Improvements or additions to public-facing documentation label Jun 6, 2025

@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!

@dhruvmanila dhruvmanila changed the title Fix doc for nvim setting examples Fix doc for Neovim setting examples Jun 6, 2025
@dhruvmanila
dhruvmanila merged commit 8d24760 into astral-sh:main Jun 6, 2025
@shimies
shimies deleted the fix-docs-for-nvim-settings branch June 6, 2025 09:50
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