godot-rust / godot-rust/gdext

Enable `register-docs` by default

Open
#1,389 0 comments 8 reactions 0 assignees View on GitHub
quality-of-life
Dominant language
Rust
Stars
5.2k
Forks
312
Avg merge
12h 59m
Merged PRs (30d)
9

Description

For UX reasons, it would be nice to have `register-docs` default-on. Quite a few people have already wondered why their RustDoc comments aren't shown in the editor.

We could disable the registration of docs at runtime if Godot runs in release/exported mode.

This would come at the cost of the (lightweight) `markdown` + `unicode-id` dependencies, which I think is acceptable.

In theory we can still keep the feature and let people opt _out_ of it, however right now we have a setup that mandates several private features like `__codegen-full` to be provided. Maybe there's another way to set this up for CI and `check.sh`, e.g. through a command-line `cfg`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.