godot-rust / godot-rust/gdext

add support for internal getter and setter functions

Closed Beginner friendly
#1,691 11 comments 0 reactions 0 assignees View on GitHub
c: register feature
Dominant language
Rust
Stars
5.2k
Forks
312
Avg merge
12h 59m
Merged PRs (30d)
9

Description

Adding a `#[doc(hidden)]` where `#[func]` is present hides the function from Godot's documentation which is great.

This seems to be undocumented which caused me to spend some time trying to hide an internal/hidden getter/setter function when a simple `#[doc(hidden)]` attribute would have been enough.

Would be nice if it was added to the docs so anyone else doesn't waste time like I did.

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation for #[func] and the existing explanation of #[doc(hidden)]. Add a note explaining that #[doc(hidden)] can hide internal getter and setter functions from Godot's documentation, then verify the resulting documentation clearly covers this use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
godot, rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.