Explain how to register editor docs (`register-docs` feature)

[ionthedev]

Perhaps I am failing to find it in the documentation, but I would love to be able to use /// documentation to be able to populate the in script editor tool tip. If that is not possible due to the GDExtenstion bindings, then I would love to see documentation on how to set that up relative to a godot-rust extension.

[kistz]

Hey :)
Its behind the register-docs feature flag.
But this came up so many times now that including it in the book might be a good thing ^^ Have a good day

[Yarwin]

It is briefly mentioned in api-docs which links to Documentation section in #[derive(GodotClass]

I do agree, covering this topic in book (even briefly) would be good

[aurorameccanicadev]

Thank you, same confusion for me, found out how to do it from this issue

Maybe it's better to simply enable the feature by default if the chosen api version is recent enough. Is there any drawback?

[Bromeon]

Maybe it's better to simply enable the feature by default if the chosen api version is recent enough. Is there any drawback?

That's planned as well, but there are some things we need to sort out so that --no-default-features is properly usable. Then, we could have it enabled by default, but opt-out for those who don't need it (and its 2 dependencies markdown + litrs).

[Bromeon]

Brief example is used in this devlog, section Generating Godot docs from RustDoc:
https://godot-rust.github.io/dev/november-2024-update/

Something similar that goes into the different symbols would be nice.