tmedwards / sugarcube-2

SugarCube is a free (gratis and libre) story format for Twine/Twee.
https://www.motoslave.net/sugarcube/2/
BSD 2-Clause "Simplified" License
177 stars 41 forks source link

[Docs] Clarify that "current passage" means the current moment, not the passage the code is running from within. #51

Closed ChapelR closed 4 years ago

ChapelR commented 4 years ago

For example, the tags() function features this line:

If omitted, will default to the current passage.

Some users have interpreted this to mean the passage the code is in rather than the passage associated with the current moment, e.g., they believe a tags() call in PassageHeader would return the tags of the PassageHeader passage.

I do not think the docs as written are necessarily unclear, but I think it wouldn't hurt to specify what is meant by the "current passage."

tmedwards commented 4 years ago

Ending up making two commits addressing this—one for the argument text and a another later for the example. Better?

ChapelR commented 4 years ago

Looks good to me.