Skip to content

Commit 3b002fd

Browse files
joshkaEdJoPaTo
andauthored
docs: update incompatible code warning in examples readme (#1013)
Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de>
1 parent 0207160 commit 3b002fd

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

examples/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Examples
22

3-
This folder contains unreleased code. View the [examples for the latest release
4-
(0.25.0)](https://github.com/ratatui-org/ratatui/tree/v0.25.0/examples) instead.
3+
This folder might use unreleased code. View the examples for the latest release instead.
54

65
> [!WARNING]
76
>
8-
> There are backwards incompatible changes in these examples, as they are designed to compile
7+
> There may be backwards incompatible changes in these examples, as they are designed to compile
98
> against the `main` branch.
109
>
1110
> There are a few workaround for this problem:
1211
>
1312
> - View the examples as they were when the latest version was release by selecting the tag that
14-
> matches that version. E.g. <https://github.com/ratatui-org/ratatui/tree/v0.25.0/examples>. There
15-
> is a combo box at the top of this page which allows you to select any previous tagged version.
16-
> - To view the code locally, checkout the tag using `git switch --detach v0.25.0`.
17-
> - Use the latest [alpha version of Ratatui]. These are released weekly on Saturdays.
13+
> matches that version. E.g. <https://github.com/ratatui-org/ratatui/tree/v0.26.1/examples>.
14+
> - If you're viewing this file on GitHub, there is a combo box at the top of this page which
15+
> allows you to select any previous tagged version.
16+
> - To view the code locally, checkout the tag. E.g. `git switch --detach v0.26.1`.
17+
> - Use the latest [alpha version of Ratatui] in your app. These are released weekly on Saturdays.
1818
> - Compile your code against the main branch either locally by adding e.g. `path = "../ratatui"` to
1919
> the dependency, or remotely by adding `git = "https://github.com/ratatui-org/ratatui"`
2020
>

0 commit comments

Comments
 (0)