Use GitHub admonition syntax for the warning in README #1543
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
force-pushed
the
readme-use-github-admonition-syntax
branch
from
b146031 to
26459dc
Compare
Calinou
commented
Aug 5, 2024
Comment on lines
+52
to
+65
| > [!WARNING] | ||
| > | ||
| > The GDExtension API is brand new in Godot 4.0, and is still | ||
| considered in **beta** stage, despite Godot 4.0 itself being released. | ||
|
|
||
| This applies to both the GDExtension interface header, the API JSON, and this | ||
| > | ||
| > This applies to both the GDExtension interface header, the API JSON, and this | ||
| first-party `godot-cpp` extension. | ||
|
|
||
| Some compatibility breakage is to be expected as GDExtension and `godot-cpp` | ||
| get more used, documented, and critical issues get resolved. See the | ||
| [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension) | ||
| and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues) | ||
| for a list of known issues, and be sure to provide feedback on issues and PRs | ||
| which affect your use of this extension. | ||
| > | ||
| > Some compatibility breakage is to be expected as GDExtension and `godot-cpp` | ||
| > get more used, documented, and critical issues get resolved. See the | ||
| > [Godot issue tracker](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aopen+label%3Atopic%3Agdextension) | ||
| > and the [godot-cpp issue tracker](https://github.com/godotengine/godot-cpp/issues) | ||
| > for a list of known issues, and be sure to provide feedback on issues and PRs | ||
| > which affect your use of this extension. |
There was a problem hiding this comment.
We might consider dropping this warning (or turning it into a simple [!NOTE]) after Godot 4.3 is released, as compatibility breakage seems less common lately.
dsnopek
approved these changes
Aug 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview: https://github.com/Calinou/godot-cpp/blob/readme-use-github-admonition-syntax/README.md