-
Notifications
You must be signed in to change notification settings - Fork 208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs.rs source code not accessible for gdnative::api
symbols
#943
Comments
Question: is the generated source code ever going to be actually useful for end users? I'm aware that some were led to believe that the methods don't exist because they can't follow the source link, but perhaps it's better to approach this from a documentation perspective, than to try and fight with rustdoc and complicate the build process? We can, for example, emit a short notice like:
... for each of the methods. I recall there being some way to detect whether the program is being compiled for docs.rs, which can optionally be used to reduce clutter when the docs are being built locally. |
For symbols inside
gdnative::api
module, navigating to the source code leads to an error.In gdnative 0.10.1:
KinematicBody::move_and_slide
, then click[source]
This was already present in 0.9.0:
KinematicBody::move_and_slide
, then click[src]
Result:
It's likely happening because this file is generated (filename
generated.rs
) and part of thetarget
folder. It's also not checked into version control. Maybe moving it to agen/
folder insidesrc
could help.The text was updated successfully, but these errors were encountered: