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

Document typed dictionaries in GDScript #10747

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

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Mar 5, 2025

This is copied (and adapted) from the related array documentation.

@Calinou Calinou added enhancement topic:gdscript area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.4 labels Mar 5, 2025
Typed dictionaries have the syntax ``Array[KeyType, ValueType]``, where ``KeyType`` and ``ValueType``
can be any ``Variant`` type, native or user class, or enum. Both the key and value type **must** be specified,
but you can use ``Variant`` to make either of them untyped.
Nested dictionary types (like ``Dictionary[String, Dictionary[String, int]]``)
Copy link
Member

Choose a reason for hiding this comment

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

The error message thrown says Nested typed collections are not supported., this includes both Dictionary and Array.
It could be misunderstood as "Dictionary" as a type cant be used, instead of typed dictionary.

Suggested change
Nested dictionary types (like ``Dictionary[String, Dictionary[String, int]]``)
Nested typed collections (like ``Dictionary[String, Dictionary[String, int]]``)

The wording in the typed array section should probably be updated, too.
same with static_typing.rst line 242

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

Successfully merging this pull request may close these issues.

3 participants