Document the return values of resize on packed arrays

[theraot]

Your Godot version:

v4.4.stable.official [4c311cbee]

Issue description:

The resize method of packed array returns int, but the documentation does not explain what the value is. In practices it returns 0 and for what I understand from the source code it is an Error. So, I presume the only other possible value is ERR_OUT_OF_MEMORY.

Note that it is not hard to imagine that the return value is something related to the size.

URL to the documentation page (if already existing):

• https://docs.godotengine.org/en/stable/classes/class_packedbytearray.html#class-packedbytearray-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedcolorarray.html#class-packedcolorarray-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedfloat32array.html#class-packedfloat32array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedfloat64array.html#class-packedfloat64array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedint32array.html#class-packedint32array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedint64array.html#class-packedint64array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedstringarray.html#class-packedstringarray-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedvector2array.html#class-packedvector2array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedvector3array.html#class-packedvector3array-method-resize
• https://docs.godotengine.org/en/stable/classes/class_packedvector4array.html#class-packedvector4array-method-resize

[theraot]

The method append/push_back also has an undocumented return value.

Addednum: Looking at the source code, I find that append/push_back return true if resize failed internally, and false if it completed normally.

[Monochrome-debug]

So you just want resize() to show it's return value in the docs?

[Monochrome-debug]

So like the commit I just made?

[theraot]

That's the idea. But no. Make the commit against the main Godot repository: https://github.com/godotengine/godot/tree/master/doc As far as I know the files you edited are autogenerated from that. And then a pull request saying it fixes my issue, so it can be reviewed and merged.

I made the issue because these in particular can be confusing (resize returns and int, but it has nothing to do with size, and append returns a bool, but it is true on failure). But there are other things you can add like that to the docs if you want to continue doing this kind of commits.

[Monochrome-debug]

Is the new description I made good?

[theraot]

It does what I asked. Yet, take other parts of the documentation as example of how to phrase it. For instance Array Insert: https://docs.godotengine.org/en/stable/classes/class_array.html#class-array-method-insert and once you make a pull request against the main godot repository it would be reviewed, and if there is anything missing or unclear they will tell you. In fact, I'm hoping somebody more familiar with it to have a look at it, not just me.

[Monochrome-debug]

I made some changes in the official godot repo and declared a pull request: godotengine/godot#104258

[tetrapod00]

Closed by godotengine/godot#104258