Skip to content

Conversation

Khushi-Chaudhary04
Copy link
Contributor

@Khushi-Chaudhary04 Khushi-Chaudhary04 commented Sep 27, 2025

πŸ—’οΈ Description

This PR adds a new troubleshooting entry to docs/getting_started/installation_troubleshooting.md to help users resolve a common issue with the Ruff formatter in VS Code.

πŸ”— Related Issues or PRs

Closes #1078

βœ… Checklist

  • All: Ran fast tox checks to avoid unnecessary CI fails, see also Code Standards and Enabling Pre-commit Checks:
    uvx --with=tox-uv tox -e lint,typecheck,spellcheck,markdownlint
  • All: PR title adheres to the repo standard - it will be used as the squash commit message and should start type(scope):.
  • All: Considered adding an entry to CHANGELOG.md. skipped
  • All: Considered updating the online docs in the ./docs/ directory.
  • All: Set appropriate labels for the changes (only maintainers can apply labels).
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

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

Thanks @Khushi-Chaudhary04 for adding this, I have a few very minor suggestions. I hope you don't mind that I'll add these up front and get this merged!

@danceratopz danceratopz changed the title docs: add troubleshooting entry for ruff docs(tooling): add vs code autoformat troubleshooting entry for ruff Sep 29, 2025
@danceratopz danceratopz changed the title docs(tooling): add vs code autoformat troubleshooting entry for ruff docs(tooling): add vs code ruff autoformat troubleshooting entry Sep 29, 2025
@danceratopz danceratopz changed the title docs(tooling): add vs code ruff autoformat troubleshooting entry docs(tooling): add troubleshooting entry for vs code autoformatting Sep 29, 2025
@danceratopz
Copy link
Member

Looks great, thanks again @Khushi-Chaudhary04!

image

@danceratopz danceratopz added scope:tooling Scope: Python tools (uv, ruff, tox,...) type:docs Type: Changes to the documentation labels Sep 29, 2025
@danceratopz danceratopz merged commit 6262592 into ethereum:main Sep 29, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:tooling Scope: Python tools (uv, ruff, tox,...) type:docs Type: Changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(tooling): add a troubleshooting entry for "autoformat on save" with ruff not working
2 participants