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

Builtin docs (impl blocks, navigation table, link to Godot) #821

Merged
merged 3 commits into from
Jul 27, 2024

Conversation

Bromeon
Copy link
Member

@Bromeon Bromeon commented Jul 27, 2024

Changes:

  • Vector types now have fewer useless impl blocks (e.g. separating constants).
  • The remaining impls are named and anchor-linked from struct docs.
  • For vectors, matrices, bounding boxes and strings, there is a new table with links to the other entries in the same category.
  • Every builtin type (except packed arrays) now has a link to Godot doc page.

@Bromeon Bromeon added documentation Improvements or additions to documentation c: core Core components labels Jul 27, 2024
@Bromeon Bromeon force-pushed the doc/vector-impls branch from 68df9e7 to 673275f Compare July 27, 2024 22:37
@GodotRust
Copy link

API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-821

@Bromeon Bromeon added this pull request to the merge queue Jul 27, 2024
Merged via the queue into master with commit bf67856 Jul 27, 2024
14 checks passed
@Bromeon Bromeon deleted the doc/vector-impls branch July 27, 2024 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: core Core components documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants