docs: add pyrefly tabs alongside mypy in type-checking guide#816
Merged
Conversation
Show Pyrefly as a tabbed alternative to MyPy in the Type checking section, covering the pre-commit hook and the pyproject.toml configuration. Tabs use `:sync:` so the checker choice stays consistent across both snippets. Assisted-by: ClaudeCode:claude-opus-4.8
henryiii
commented
Jun 23, 2026
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
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.
🤖 AI text below 🤖
Adds Pyrefly as a tabbed alternative to MyPy in the Type checking section of
docs/guides/style.md, using the existing mystmdtab-set/tab-itemconvention with:sync:so the checker choice stays consistent across snippets.What changed
facebook/pyrefly-pre-commit,id: pyrefly-check).pyproject.tomlconfig — tab-set keeping the full MyPy config (incl.{rr}repo-review codes) and a new Pyrefly tab.Pyrefly equivalents used
files = "src"project-includes = ["src"]python_versionpython-versionstrict = truepreset = "strict"[[tool.mypy.overrides]]+ignore_missing_importsignore-missing-imports = ["numpy"][tool.pyrefly.errors]table# type: ignore# pyrefly: ignore(also honors# type: ignore)Notes
docs/guides/mypy.mdleft untouched — it's a conceptual typing deep-dive (MyPy as the running example), with no tool config that maps to a Pyrefly variant.rev: "1.1.1". Worth confirming the version against repo conventions.myst build --html(no warnings).📚 Documentation preview 📚: https://scientific-python-cookie--816.org.readthedocs.build/