Skip to content

Move C++ container type information from C++ usage guidelines to Core types #10988

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Jun 3, 2025


  • List recommended types at the top.
  • Link references directly in the table.
  • Remove References headings in the rest of the page.
  • Update Core types for Godot 4.5.
    • Remove OAHashMap as it's no longer present in 4.5.

@Calinou Calinou added area:contributing Issues and PRs related to the Contributing/Development section of the documentation cherrypick:4.4 enhancement labels Jun 3, 2025
@Calinou Calinou force-pushed the cpp-usage-guidelines-link-to-core-types branch from 23dcc32 to 26949d5 Compare June 3, 2025 20:49
Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

I also added a link to the table in faq.rst a few commits ago; that one should be adjusted to point here instead too.

References:
~~~~~~~~~~~
References
~~~~~~~~~~

- `core/math <https://github.com/godotengine/godot/tree/master/core/math>`__

NodePath
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this one belongs in the table?
It's not a typical 'container' per se, but it is somewhat similar to std::filesystem::path maybe.
Either way it feels a bit weird to have some types up there and some other types down here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed References headings to simplify the page a bit, but I kept the text intact.

I could perhaps merge types like Face3 in the table, but I feel they're a bit too specific. We should also cover typedefs like Point2 and Size2, but this is likely best done in a future PR.

@Calinou Calinou force-pushed the cpp-usage-guidelines-link-to-core-types branch 3 times, most recently from cf78f69 to 23f8f5d Compare June 6, 2025 16:17
… types

- List recommended types at the top.
- Link references directly in the table.
- Remove References headings in the rest of the page.
- Update Core types for Godot 4.5.
  - Remove OAHashMap as it's no longer present in 4.5.
@Calinou Calinou force-pushed the cpp-usage-guidelines-link-to-core-types branch from 23f8f5d to a7eabf7 Compare June 6, 2025 20:06
Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You forgot the link i mentioned above :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation cherrypick:4.4 enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants