Skip to content

Channel storage prop array docs#67

Open
tudddorrr wants to merge 1 commit intomainfrom
channel-storage-prop-arrays
Open

Channel storage prop array docs#67
tudddorrr wants to merge 1 commit intomainfrom
channel-storage-prop-arrays

Conversation

@tudddorrr
Copy link
Copy Markdown
Contributor

No description provided.

@claude
Copy link
Copy Markdown

claude bot commented Mar 30, 2026

Documentation Review


🔴 Accuracy & Completeness

Godot — "Setting storage prop arrays" code example uses an undefined entity variable:

The code example uses entity.insert_into_prop_array() and entity.find_props_by_key() but entity is never declared or explained anywhere in the section. A developer reading this would not know what type it is or how to obtain one. This blocks users from following the example. The example needs either a declaration showing how entity is obtained, or a prose note explaining its type and origin.


🟡 Structure & Organization

Unity title changed without corresponding content:

The Unity channels.mdx title is updated to # Channels and storage, but no prop array sections are added to match the Godot page. If Unity does not yet support prop arrays, the title change is misleading. Either revert the Unity title or add a note indicating this feature is Godot-only for now.


🔵 Clarity & Readability

Vague cross-reference in "Setting storage prop arrays":

You can handle failures in the same way as described above.

"Described above" is ambiguous — it could point to the info callout or the "Handling failures" subsection further up the page. Suggest linking directly:

You can handle failures using the channel_storage_props_failed_to_set signal, as described in Handling failures above.


The new prop array sections are a welcome addition and the info callout documenting the [] suffix is a useful gotcha to surface.

@tudddorrr tudddorrr force-pushed the channel-storage-prop-arrays branch from 449f966 to e355d2f Compare March 30, 2026 23:23
@claude
Copy link
Copy Markdown

claude bot commented Mar 30, 2026

PR Review: Channel storage prop array docs

This PR adds clear, well-structured documentation for prop arrays in the Godot channels page. The code examples are readable and the info callout about the [] suffix is a helpful gotcha. Two minor polish issues below.


ScopeBadges placement inconsistency

In the new "Getting storage prop arrays" section, the description text appears before \<ScopeBadges\>, which is the opposite of every other section on the page.

Current:

### Getting storage prop arrays

Prop arrays are made up of multiple props with the same key. To fetch all items in a prop array, use `Talo.channels.get_storage_prop_array()`:

<ScopeBadges scope='gameChannels' read />

Expected (consistent with all other sections):

### Getting storage prop arrays

<ScopeBadges scope='gameChannels' read />

Prop arrays are made up of multiple props with the same key. To fetch all items in a prop array, use `Talo.channels.get_storage_prop_array()`:

Missing code formatting in info callout

The [] suffix and key names in the info callout should be formatted as inline code for clarity.

Current:

Array keys are internally suffixed with [] (e.g. a key of "world_items" is stored as "world_items[]").
When using the prop-array-specific functions, you should reference the key without the [] suffix.

Suggested:

Array keys are internally suffixed with [] (e.g. a key of "world_items" is stored as "world_items[]").
When using the prop-array-specific functions, you should reference the key without the [] suffix.


Otherwise the content is accurate, well-organised and a solid addition to the docs.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant