Skip to content
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

Add bookmark links ("¶") next to function names in docs for convenience #9664

Closed
micalpixel opened this issue Jul 27, 2024 · 1 comment
Closed

Comments

@micalpixel
Copy link

Your Godot version:

(not relevant to issue)

Issue description:

For major headers in the Godot docs, there is a convenient "¶" link that appears if you hover over it, which can be used to refer others to that exact header in the documentation. This is helpful when assisting others with understanding Godot.

For example, on the AnimatedSprite2D page, you'll see this on the "Method Descriptions" header. I can directly link to it like this, AND right click the ¶ to copy this link.
https://docs.godotengine.org/en/stable/classes/class_animatedsprite2d.html#method-descriptions

pilcro

However, such behavior does not exist for the function headers such as get_playing_speed() in the screenshot above. They do have unique IDs in the HTML, so I can link directly them, but I have to actually dig into the HTML itself to acquire the ID string and then make a full url for it. There is no "¶" link that I can simply copy for the functions:
https://docs.godotengine.org/en/stable/classes/class_animatedsprite2d.html#class-animatedsprite2d-method-set-frame-and-progress

The lack of "¶" links for function names makes it harder to link users to ones which may be relevant to them in the help forums. Since these methods already have unique IDs, all that's needed is to actually add a link to them.

I propose that "¶" links be added for function name headers just like they are for higher-level headers.

URL to the documentation page (if already existing):

(see above)

@AThousandShips
Copy link
Member

AThousandShips commented Jul 27, 2024

This has already been implemented in the latest version of the documentation, closing as this is already implemented, check the latest version instead

This was implemented in:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants