From 9731f96fb40bfa6ebf2c8db9d3d00b9881b2842c Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Sat, 28 Jan 2023 03:31:20 +0100 Subject: [PATCH] fix: typo in BREAKING_CHANGES.md & improve wrapping --- BREAKING_CHANGES.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index 7eaf98e893..10a217e590 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -17,25 +17,25 @@ ruff --explain E402 --format json # Works! ruff explain E402 --format json # Works! (And preferred.) -This change is largely backwards compatible -- most users should experience no change in behavior. -However, please note the following exceptions: +This change is largely backwards compatible -- most users should experience +no change in behavior. However, please note the following exceptions: -* Subcommands will now fail when invoked with unsupported arguments, instead of silently ignoring - them. For example, the following will now fail: +* Subcommands will now fail when invoked with unsupported arguments, instead + of silently ignoring them. For example, the following will now fail: ruff --explain E402 --respect-gitignore - (`explain` command doesn't support `--respect-gitignore`.) + (the `explain` command doesn't support `--respect-gitignore`.) -* The semantics of `ruff ` have changed slightly when `` is a valid subcommand. For - example, prior to this release, running `ruff explain` would run `ruff` over a file or directory - called `explain`. Now, `ruff explain` would invoke the `explain` subcommand. +* The semantics of `ruff ` have changed slightly when `` is a valid subcommand. + For example, prior to this release, running `ruff explain` would run `ruff` over a file or + directory called `explain`. Now, `ruff explain` would invoke the `explain` subcommand. -* Scripts that nvoke ruff should supply `--` before any positional arguments. (The semantics of - `ruff -- ` have not changed.) +* Scripts that invoke ruff should supply `--` before any positional arguments. + (The semantics of `ruff -- ` have not changed.) -* `--explain` previously treated `--format grouped` as a synonym for `--format text`. This is no - longer supported; instead, use `--format text`. +* `--explain` previously treated `--format grouped` as a synonym for `--format text`. + This is no longer supported; instead, use `--format text`. ## 0.0.226