A_ThisLabel references needed Topic is solved

Share your ideas as to how the documentation can be improved.
joefiesta
Posts: 494
Joined: 24 Jan 2016, 13:54
Location: Pa., USA

A_ThisLabel references needed

Post by joefiesta » 14 Jun 2021, 08:59

I had great difficulty finding the way to get the name of the called (via gosub or goto or gui g-label) subroutine today.

It would be very helpful if GoSub and Goto included mentioning that they set A_ThisLabel or A_ThisLabel is added to the these command's "RELATED" section.

Additionally, GUI g-label states
The subroutine may consult the following built-in variables: A_Gui, A_GuiControl, A_GuiEvent, and A_EventInfo.
To this list should also be added A_This_Label.

swagfag
Posts: 6222
Joined: 11 Jan 2017, 17:59

Re: A_ThisLabel references needed

Post by swagfag » 14 Jun 2021, 09:28

the listed labels are populated only as a result of a gui event invoking them, whereas A_ThisLabel is queryable from any label, so it doesnt belong in this list

about the other points, sure i guess

lexikos
Posts: 9553
Joined: 30 Sep 2013, 04:07
Contact:

Re: A_ThisLabel references needed

Post by lexikos » 15 Jun 2021, 03:05

I think both suggestions are reasonable, aside from the typo.

A_EventInfo is not only populated as a result of a GUI event.

User avatar
Ragnar
Posts: 611
Joined: 30 Sep 2013, 15:25

Re: A_ThisLabel references needed  Topic is solved

Post by Ragnar » 21 Jun 2021, 04:48

Changes added in PR #487.

Post Reply

Return to “Suggestions on Documentation Improvements”