GDScript: Add CONFUSABLE_CAPTURE_REASSIGNMENT warning

[dalexeev]

• Resolves Closure fails to update primitive parameter #93070
  • in combination with GDScript: Update lambda documentation godot-docs#9556.
• See also GDScript: Capture local variables consistently godot-proposals#8558.

This is not a bug fix, but I think it would be nice to add the warning in 4.3, since this behavior is quite confusing while the change is simple and low risk.

[Mickeon]

Both the name and documentation description of this warning do not mean much to the user that is going to stumble upon this warning while writing a lambda function.

[dalexeev]

@Mickeon What exactly causes you concern? Is the problem in the wording or terminology? Can you suggest a better option?

[Mickeon]

The warning's name sounds correct, but it's a bit hard to understand. "Confusable", but why? It's somewhat broad. An assignment can be "confusing" for a few other reasons too.
Nowhere in the description it is stated that this is explicitly for lambdas, too. You may be able to infer it because you know how "capturing" works, but to whoever this warning may be beneficial to, that's not guaranteed.

I have no other better suggestions at the moment. I just know that because this is a very specific warning, it needs a very specific name (potentially just mentioning lambdas/callables directly?).

[akien-mga]

Makes sense to me.

I agree that it could use mentioning lambdas at least in the description, and maybe in the warning's name (but that will start being long).
People familiar with lambdas will understand what capture refers to, but people not familiar with lambdas will also be going through the list of warnings to see what's useful to them, so it would help to scope it better to the relevant concept.

[dalexeev]

Nowhere in the description it is stated that this is explicitly for lambdas, too.

You are right, I forgot to add this to the Project Settings description, although it is present in the warning message: Reassigning lambda capture does not modify the outer local variable "%s".

I agree that it could use mentioning lambdas at least in the description, and maybe in the warning's name (but that will start being long).

I thought about CONFUSABLE_LAMBDA_CAPTURE_REASSIGNMENT, but then that would be the longest warning code.

[Mickeon]

Begrudgingly we cannot have warning names that span the width of your monitor.

[dalexeev]

Begrudgingly we cannot have warning names that span the width of your monitor.

[akien-mga]

Thanks!