docs: add Flycheck note to Emacs editor integration#3528
Merged
Conversation
Document how Flycheck users can surface ty diagnostics through the flycheck-eglot bridge, addressing a setup variant requested in astral-sh#2902.
dhruvmanila
reviewed
May 25, 2026
Removed example configuration for flycheck-eglot.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Adds a short note to the Emacs section of the editor integration docs explaining how Flycheck users can route ty's diagnostics through the flycheck-eglot bridge.
The current Eglot snippet (added in #3107) covers the simple case, but the original request in #2902 specifically asked about Flycheck-based setups. This adds the minimal additional snippet for that path without changing the existing recommended setup. Modeled on the multi-subsection layout used by Ruff's Emacs docs.
Refs #2902.
Test Plan
mdformat docs/editors.md --checkpassesmarkdownlint-cli@0.48.0 docs/editors.mdpassesflycheck/flycheck-eglotis the official upstream package