Skip to content

Conversation

@Ivorforce
Copy link
Member

@Ivorforce Ivorforce commented Sep 22, 2025

  • Pair: Mention KeyValue. KeyValue could get its own entry, but there is nothing much to say, and KeyValue is unlikely to be used outside of containers.
  • RBMap: Discourage its use. We might actually phase it out fully in the future.
  • Span: Make it clear it's low level API. People should be careful when using this.
  • String: Clarify UTF-32 motivation. UTF-32 isn't actually more performant in all respects (it's a RAM hog), but it is simpler to work with.

@Ivorforce Ivorforce requested a review from Calinou September 22, 2025 14:53
@Ivorforce Ivorforce added enhancement area:engine details Issues and PRs related to the Engine Details section of the documentation cherrypick:4.5 labels Sep 22, 2025
| |span| | ``std::span`` | Represents read-only access to a contiguous array without needing to copy any data. |
| | | See `pull request description <https://github.com/godotengine/godot/pull/100293>`__ |
| | | for details. |
| | | Note that ``Span`` is designed to be a high performance API: It does not perform |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| | | Note that ``Span`` is designed to be a high performance API: It does not perform |
| | | Note that ``Span`` is designed to be a high performance API: it does not perform |

Copy link
Member

Choose a reason for hiding this comment

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

You reverted this change, was that intentional?

Copy link
Member Author

Choose a reason for hiding this comment

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

When I looked at this, the discussion was already resolved, so I assumed it wasn't relevant after all. Doesn't the sentence after a semicolon begin uppercase if it's a full sentence?

Copy link
Member

@Calinou Calinou 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 to me.

…` (discourage its use), `Span` (make it's clear it's low level API), and `String` (clarify UTF-32 motivation).
@mhilbrunner mhilbrunner merged commit 5b0db18 into godotengine:master Sep 24, 2025
1 check passed
@mhilbrunner
Copy link
Member

Thank you!

@Ivorforce Ivorforce deleted the core-types-update branch September 24, 2025 11:51
@mhilbrunner
Copy link
Member

Cherrypicked to 4.5 in #11337 and to stable in #11338.

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

Labels

area:engine details Issues and PRs related to the Engine Details section of the documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants