godotengine / godotengine/godot-docs

Please better explain how Arrays are shared

Open
#2,909 11 comments 2 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

In the [Array docs](https://docs.godotengine.org/en/3.1/classes/class_array.html#description), all we have right now is this line:

> Arrays are always passed by reference.

For someone who does not know what "passed by reference" means it means nothing.

I only learned through painful trail and error and by wasting a lot of time even that Arrays are somehow shared and PoolXArrays are not. I would have searched what "passed by reference" means sooner, if I somehow knew this expression is connected to my Array changing throughout my running project.
I think the Array documentation should have a clear statement about the fact that it is shared, a statement that is even understood by people who do no know yet what "passed by reference" means, or at the very least some hint that those are connected.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.