Rename Array.invert() to Array.reverse()

[madmiraal]

Does the same internally for List and Vector<>, which includes all PackedArray types.

Part of #16863.

[madmiraal]

Rebased following merge of #47024.

[akien-mga]

Makes sense to me, that's consistent with Python 3's array.reverse(), and avoids potential confusion with insert().

Anyone against the change?

[akien-mga]

Seems consensual!

[akien-mga]

Thanks!

[MaaaxiKing]

Does this set or return? I find invert() better if it was set, but not only reverse() but reversed() for a return method without setting it. Comprehensible?

[Calinou]

@MaaaxiKing The return type is unchanged – it's still void().

I think we should make this method return a new Array instead. Since renaming the method is a breaking change already, we might as well do it for 4.0. In general, I'd steer clear from methods that modify things in-place as much as possible.

[madmiraal]

Unlike other ideally immutable types, Arrays are designed to be manipulated "in-place". It would be expensive to create a new array every time it was changed or assigned, which is also why they are passed by reference. Furthermore, when the user does want a copy, they need to specify whether they just want the Array copied or the individual items of the Array too, which is why duplicate(bool deep=false) has a parameter associated with it.

[YuriSizov]

@madmiraal Please use doctool with your renaming PRs. This one broke the alphanumeric order which results in unnecessary changes for others.

[madmiraal]

We should probably include it in the CI checks somehow.

[aaronfranke]

@madmiraal I've been wanting to do this for a long time, but right now doctool has to open a window first, and there's no headless DisplayServer available for Godot as of the DisplayServer split.

[madmiraal]

Unless I'm doing something wrong, the doctool doesn't warn about items being out of alphanumeric order.

[akien-mga]

It doesn't warn but it should fix the order. If there's any diff, then it could fail CI (if we could run it on CI).

[madmiraal]

I'm running ed2f51b (i.e. before #47631) with --doctool and it doesn't fix the alphanumeric order. In doc/classes/Array.xml, <method name="reverse"> is still before <method name="is_empty" qualifiers="const"> 😕

[akien-mga]

Are you running with bin/godot --doctool . (with the .)?
If so it might be a system-specific issue, in the past doctool produced inconsistent ordering on Windows but I thought this has been fixed.

[madmiraal]

I was not. It works when I include the .. 🎉 😃