mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-30 08:23:53 +00:00
099f077311
## Summary <!-- What's the purpose of the change? What does it do, and why? --> This PR updates the metadata in the YAML frontmatter of the mkdocs documentation to include the rule short code as a tag, so it can be easily searched. Ref: #13684 ## Test Plan <!-- How was it tested? --> This has been tested locally using the documentation provided [here](https://docs.astral.sh/ruff/contributing/#mkdocs) for generating docs. This generates docs that now have the tags section: ```markdown --- description: Checks for abstract classes without abstract methods. tags: - B024 --- # abstract-base-class-without-abstract-method (B024) ... trimmed ``` I've also verified that this gives the ability to get straight to the page via search when serving mkdocs locally. --------- Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com> |
||
|---|---|---|
| .. | ||
| benchmarks | ||
| fuzz-parser | ||
| knot_benchmark | ||
| release | ||
| _mdformat_utils.py | ||
| _utils.py | ||
| add_plugin.py | ||
| add_rule.py | ||
| check_docs_formatted.py | ||
| check_ecosystem.py | ||
| Dockerfile.ecosystem | ||
| ecosystem_all_check.py | ||
| ecosystem_all_check.sh | ||
| ecosystem_all_check_entrypoint.sh | ||
| formatter_ecosystem_checks.sh | ||
| generate_builtin_modules.py | ||
| generate_known_standard_library.py | ||
| generate_mkdocs.py | ||
| pyproject.toml | ||
| release.sh | ||
| transform_readme.py | ||
| update_ambiguous_characters.py | ||
| update_schemastore.py | ||