(Solved) Editing Renpy Documentation (Renpy.Org)?

Discuss how to use the Ren'Py engine to create visual novels and story-based games. New releases are announced in this section.
Forum rules
This is the right place for Ren'Py help. Please ask one question per thread, use a descriptive subject like 'NotFound error in option.rpy' , and include all the relevant information - especially any relevant code and traceback messages. Use the code tag to format scripts.
Post Reply
Message
Author
User avatar
SypherZent
Veteran
Posts: 362
Joined: Fri Sep 02, 2016 3:14 am
Completed: Multiverse Heroes, Space Hamster in Turmoil
Location: Puerto Rico
Contact:

(Solved) Editing Renpy Documentation (Renpy.Org)?

#1 Post by SypherZent »

Hi, odd question.

In the documentation for SetVariable on the site:
https://www.renpy.org/doc/html/screen_actions.html

Is there a way to update this information?

When there is a bug, the error log Ren'Py provides, sometimes refers to 00* renpy files, and not directly to the code the user wrote.
In the specific case of using SetVariable(x,y) this will occur in the context of being located within an If within an action of a textbutton on a screen used by a screen.

The correct syntax is SetVariable("x",y).
The documentation on the site should be updated to say this, because it's very confusing and I fear some people may lose hours due to the lack of proper error_log during certain usage, as well as the vague definition for SetVariable on the website.

Current:

Code: Select all

SetVariable(variable, value)
Causes variable to be set to value.
Suggested:

Code: Select all

SetVariable(variable, value)
Causes variable to be set to value.
Variable must be a string (i.e. str(var) or just "var").
Is there a way we can update that information ourselves, or someone to contact to do so?

Thanks in advance. ^^
Last edited by SypherZent on Fri Jan 13, 2017 9:49 pm, edited 1 time in total.

User avatar
Ocelot
Lemma-Class Veteran
Posts: 2400
Joined: Tue Aug 23, 2016 10:35 am
Github: MiiNiPaa
Discord: MiiNiPaa#4384
Contact:

Re: Editing Renpy Documentation (Renpy.Org)?

#2 Post by Ocelot »

It should probably say almost everywhere, that variable (or equivalent) is a string containing variable name. Currently it does not mention that some arguments are strings and some are not.

You can create issue on github or try to comment on this issue providing a link to this topic.
< < insert Rick Cook quote here > >

User avatar
SypherZent
Veteran
Posts: 362
Joined: Fri Sep 02, 2016 3:14 am
Completed: Multiverse Heroes, Space Hamster in Turmoil
Location: Puerto Rico
Contact:

Re: Editing Renpy Documentation (Renpy.Org)?

#3 Post by SypherZent »

Excellent, thank you Ocelot!
I will check out the GitHub for sure, did not know I could make suggestions there!

Post Reply

Who is online

Users browsing this forum: No registered users