From 4031d3c81d4c23cccef4a9952dde233e986b6517 Mon Sep 17 00:00:00 2001 From: Dhruv Manilawala Date: Wed, 8 Jan 2025 21:37:38 +0530 Subject: [PATCH] Update references --- crates/ruff_python_formatter/README.md | 2 +- docs/faq.md | 2 +- docs/formatter.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/ruff_python_formatter/README.md b/crates/ruff_python_formatter/README.md index 19f0c0065159e..d6ed9a96d8e26 100644 --- a/crates/ruff_python_formatter/README.md +++ b/crates/ruff_python_formatter/README.md @@ -19,7 +19,7 @@ filed in the issue tracker. If you've identified a new deviation, please [file a When run over _non_-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. -For details, see [Black compatibility](https://docs.astral.sh/ruff/formatter/#black-compatibility). +For details, see [Style Guide](https://docs.astral.sh/ruff/formatter/#style-guide). ## Getting started diff --git a/docs/faq.md b/docs/faq.md index 5e15dc63f19c8..431ada6329be2 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -28,7 +28,7 @@ to see a few differences on the margins, but the vast majority of your code shou When run over _non_-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. -See [_Black compatibility_](formatter.md#black-compatibility) for more. +See [_Style Guide_](formatter.md#style-guide) for more. ## How does Ruff's linter compare to Flake8? diff --git a/docs/formatter.md b/docs/formatter.md index 6c393c3b9135a..5a97f03c396ee 100644 --- a/docs/formatter.md +++ b/docs/formatter.md @@ -33,7 +33,7 @@ adoption is minimally disruptive for the vast majority of projects. Specifically, the formatter is intended to emit near-identical output when run over existing Black-formatted code. When run over extensive Black-formatted projects like Django and Zulip, > 99.9% -of lines are formatted identically. (See: [_Black compatibility_](#black-compatibility).) +of lines are formatted identically. (See: [_Style Guide](#style-guide).) Given this focus on Black compatibility, the formatter thus adheres to [Black's (stable) code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html), which aims for "consistency, generality, readability and reducing git diffs". To give you a sense