Skip to content

Commit 14461c3

Browse files
authored
docs(breaking-changes): typos and markdownlint (#1009)
1 parent 3b002fd commit 14461c3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

BREAKING-CHANGES.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document contains a list of breaking changes in each version and some notes to help migrate
44
between versions. It is compiled manually from the commit history and changelog. We also tag PRs on
5-
github with a [breaking change] label.
5+
GitHub with a [breaking change] label.
66

77
[breaking change]: (https://github.com/ratatui-org/ratatui/issues?q=label%3A%22breaking+change%22)
88

@@ -37,7 +37,7 @@ This is a quick summary of the sections below:
3737
- `Scrollbar`: symbols moved to `symbols` module
3838
- MSRV is now 1.67.0
3939
- [v0.22.0](#v0220)
40-
- serde representation of `Borders` and `Modifiers` has changed
40+
- `serde` representation of `Borders` and `Modifiers` has changed
4141
- [v0.21.0](#v0210)
4242
- MSRV is now 1.65.0
4343
- `terminal::ViewPort` is now an enum
@@ -49,14 +49,14 @@ This is a quick summary of the sections below:
4949

5050
## [v0.26.0](https://github.com/ratatui-org/ratatui/releases/tag/v0.26.0)
5151

52-
### `Flex::Start` is the new default flex mode for `Layout`
52+
### `Flex::Start` is the new default flex mode for `Layout` ([#881])
5353

5454
[#881]: https://github.com/ratatui-org/ratatui/pull/881
5555

5656
Previously, constraints would stretch to fill all available space, violating constraints if
5757
necessary.
5858

59-
With v0.26.0, `Flex` modes are introduced and the default is `Flex::Start`, which will align
59+
With v0.26.0, `Flex` modes are introduced, and the default is `Flex::Start`, which will align
6060
areas associated with constraints to be beginning of the area. With v0.26.0, additionally,
6161
`Min` constraints grow to fill excess space. These changes will allow users to build layouts
6262
more easily.
@@ -108,7 +108,7 @@ by removing the call to `.collect()`.
108108
[#751]: https://github.com/ratatui-org/ratatui/pull/751
109109

110110
The default() implementation of Table now sets the column_spacing field to 1 and the segment_size
111-
field to SegmentSize::None. This will affect the rendering of a small amount of apps.
111+
field to `SegmentSize::None`. This will affect the rendering of a small amount of apps.
112112

113113
To use the previous default values, call `table.segment_size(Default::default())` and
114114
`table.column_spacing(0)`.
@@ -222,8 +222,8 @@ widget in the default configuration would not show any indication of the selecte
222222

223223
[#664]: https://github.com/ratatui-org/ratatui/pull/664
224224

225-
Previously `Table`s could be constructed without widths. In almost all cases this is an error.
226-
A new widths parameter is now mandatory on `Table::new()`. Existing code of the form:
225+
Previously `Table`s could be constructed without `widths`. In almost all cases this is an error.
226+
A new `widths` parameter is now mandatory on `Table::new()`. Existing code of the form:
227227

228228
```diff
229229
- Table::new(rows).widths(widths)
@@ -281,7 +281,7 @@ let layout = layout::new(Direction::Vertical, [Constraint::Min(1), Constraint::M
281281

282282
## [v0.24.0](https://github.com/ratatui-org/ratatui/releases/tag/v0.24.0)
283283

284-
### ScrollbarState field type changed from `u16` to `usize` ([#456])
284+
### `ScrollbarState` field type changed from `u16` to `usize` ([#456])
285285

286286
[#456]: https://github.com/ratatui-org/ratatui/pull/456
287287

@@ -385,12 +385,12 @@ The MSRV of ratatui is now 1.67 due to an MSRV update in a dependency (`time`).
385385

386386
## [v0.22.0](https://github.com/ratatui-org/ratatui/releases/tag/v0.22.0)
387387

388-
### bitflags updated to 2.3 ([#205])
388+
### `bitflags` updated to 2.3 ([#205])
389389

390390
[#205]: https://github.com/ratatui-org/ratatui/issues/205
391391

392-
The serde representation of bitflags has changed. Any existing serialized types that have Borders or
393-
Modifiers will need to be re-serialized. This is documented in the [bitflags
392+
The `serde` representation of `bitflags` has changed. Any existing serialized types that have Borders or
393+
Modifiers will need to be re-serialized. This is documented in the [`bitflags`
394394
changelog](https://github.com/bitflags/bitflags/blob/main/CHANGELOG.md#200-rc2)..
395395

396396
## [v0.21.0](https://github.com/ratatui-org/ratatui/releases/tag/v0.21.0)
@@ -422,9 +422,9 @@ let terminal = Terminal::with_options(backend, TerminalOptions {
422422

423423
[#168]: https://github.com/ratatui-org/ratatui/issues/168
424424

425-
A new type `Masked` was introduced that implements `From<Text<'a>>`. This causes any code that did
425+
A new type `Masked` was introduced that implements `From<Text<'a>>`. This causes any code that
426426
previously did not need to use type annotations to fail to compile. To fix this, annotate or call
427-
to_string() / to_owned() / as_str() on the value. E.g.:
427+
`to_string()` / `to_owned()` / `as_str()` on the value. E.g.:
428428

429429
```diff
430430
- let paragraph = Paragraph::new("".as_ref());

0 commit comments

Comments
 (0)