Clarify Array class methods that return error

[curious-broccoli]

insert now returns an Error value so the note had to be changed. only needs to apply for 4.x I believe

perhaps the note can be removed altogether

[curious-broccoli]

In my opinion the description for insert and resize should mention that the return value is an Error. This probably applies to other functions as well

[AThousandShips]

The specification isn't needed IMO, "a value" and "an array" are equally true and we want to keep changes to the docks for non-critical reasons to a minimum

[curious-broccoli]

Well, I think it's bad that it says that nothing/no value is returned when actually an integer is returned. If the note was removed and instead the description said that an error (or an integer equaling an error) is returned it would also be clear.

[AThousandShips]

My bad that is true, then it should be changed to indicate that a error value is returned

[AThousandShips]

Would be good to look into why the Variant bindings here do not carry over the enum information, it should be documented as Error.

[YuriSizov]

LGTM now!

[AThousandShips]

Other than that nitpick LGTM

[curious-broccoli]

Should those array functions that return a int/Error show the return value as Error in the docs like it is here

godot/doc/classes/ConfigFile.xml

Line 160 in 6758a7f

<return type="int" enum="Error" />

?

[AThousandShips]

It should but it can't, see my comment above

[curious-broccoli]

It should but it can't, see my comment above

well, for Array it is only <return type="int" /> while for ConfigFile it is <return type="int" enum="Error" />. As someone who hardly knows how to write the docs I'd assume that is the problem 🙈

[AThousandShips]

The problem is that the generation system for documentation doesn't detect metadata and decorations for arguments and return values, I am aware of the difference, that's why I pointed this issue out, it's related to low level code

[YuriSizov]

Even with the return type fixed, it never hurts to be explicit in the description about what the method takes and returns. So for now fixing the docs would be fine.

[YuriSizov]

Thanks! And congrats on your first merged Godot PR!

[AThousandShips]

Marked for cherry picking as I believe the doc changes apply to 4.1 as well and clarify things

[YuriSizov]

I think we can skip cherry-picking this one.