Helpful doc aliases: func, var, init, ...
#960
Merged
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
Bromeon
added
documentation
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-960 |
Bromeon
force-pushed
the
qol/helpful-aliases
branch
from
bc52711 to
96916fa
Compare
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.
So far, it was quite hard to search for something like
#[func]or#[var]in the API docs.Now, I added doc aliases for many such keywords, so that they point to the correct symbols (
godot_api+derive(Godot)macros in this case). Hope that helps with discoverability!Also improved some minor things, such as links between traits and their derive macros.
Example: "I remember there was a way to rename functions, or was it classes? What was the syntax?"
Answer:
Live demo: https://godot-rust.github.io/docs/gdext/pr-960/godot/?search=rename