Ren'py documentation request

In this forum we discuss the future of Ren'Py, both bug fixes and longer-term development. Pre-releases are announced and discussed here.
Post Reply
Message
Author
User avatar
Luxliev
Veteran
Posts: 242
Joined: Sat Feb 07, 2015 11:01 am
Soundcloud: Luxliev
Contact:

Ren'py documentation request

#1 Post by Luxliev » Fri Jun 09, 2017 11:10 am

Is it possible to add examples to everything in new documentation? Most of the time I'm looking something up and then after trying to implement it in Ren'py I need to go back to forums and search how exactly it should look like (with brackets or without etc.). Can I update this myself? I'd like to at least update everything that I've checked out.

Example:

Code: Select all

SetVariable(variable, value)
Causes variable to be set to value.
Ok seems easy enough... Attempt 1:

Code: Select all

key "d" action SetVariable(p1_xpos, p1_xpos += 1)
Syntax error. Ok one more time. Attempt 2:

Code: Select all

key "d" action SetVariable("p1_xpos", p1_xpos += 1)
Syntax error. (Checks forums). Ooooh this is how. Attempt 3

Code: Select all

key "d" action SetVariable("p1_xpos", += 1)
It would really help a lot if we could have examples. I love Ren'py but unfortunately quite often you can find something that's not too intuitive (another example: implementing images in frames is not add imagename like in show but add "imagepath"
Newest classical cover: Advance Wars - Sami Theme: https://www.youtube.com/watch?v=657Jt7hJRVc

Forum with my music: http://luxliev.proboards.com/

User avatar
Divona
Miko-Class Veteran
Posts: 678
Joined: Sun Jun 05, 2016 8:29 pm
Completed: The Falconers: Moonlight
Organization: Bionic Penguin
itch: bionicpenguin
Contact:

Re: Ren'py documentation request

#2 Post by Divona » Fri Jun 09, 2017 12:10 pm

There were words on this about the example in the documentation from PyTom:
viewtopic.php?f=8&t=43944&p=455083#p455083

From the example above, it seems straight forward enough, though.

SetVariable(variable, value)

variable = variable name
value = value for variable

Code: Select all

default p1_xpos = p1_xpos + 1
"p1_xpos" is variable.
"p1_xpos + 1" is value.

I do agree that having all example in one place would be nice. How does the cookbook section doing nowaday?
Completed:
Image

User avatar
xavimat
Eileen-Class Veteran
Posts: 1265
Joined: Sat Feb 25, 2012 8:45 pm
Completed: Yeshua, Jesus Life, Cops&Robbers
Projects: Fear&Love, unknown
Organization: Pilgrim Creations
Github: xavi-mat
itch: xavimat
Location: Italy
Contact:

Re: Ren'py documentation request

#3 Post by xavimat » Fri Jun 09, 2017 12:19 pm

Luxliev wrote:Is it possible to add examples to everything in new documentation? ... Can I update this myself?
You can propose changes in renpy code, including the documentation, via https://github.com/renpy/renpy

For the doc is a bit tricky, but possible.

Pytom will look at it, comment if needed, and accept it if useful.
Cops&Robbers A two-player experiment
Fear&Love Why can’t we simply express our feelings? Why am I afraid to say ‘I love you’?
unknown [Sci-Fi - mystery - computer]
Honest Critique (Avatar made with Chibi Maker by ~gen8)

User avatar
Luxliev
Veteran
Posts: 242
Joined: Sat Feb 07, 2015 11:01 am
Soundcloud: Luxliev
Contact:

Re: Ren'py documentation request

#4 Post by Luxliev » Fri Jun 09, 2017 12:47 pm

I won't mess with source code but I'd like to add examples every time I use docs.
Newest classical cover: Advance Wars - Sami Theme: https://www.youtube.com/watch?v=657Jt7hJRVc

Forum with my music: http://luxliev.proboards.com/

User avatar
Amie
Regular
Posts: 28
Joined: Tue Jun 06, 2017 4:48 am
Contact:

Re: Ren'py documentation request

#5 Post by Amie » Sat Jun 10, 2017 3:20 am

Luxliev wrote:Is it possible to add examples to everything in new documentation? Most of the time I'm looking something up and then after trying to implement it in Ren'py I need to go back to forums and search how exactly it should look like (with brackets or without etc.)
I agree, this would really help, especially for new people just starting out with Ren'Py (like me) :wink:

User avatar
Black Cat 2412
Regular
Posts: 72
Joined: Wed Aug 16, 2017 10:10 am
Projects: Rapunzel: A classic retold
Deviantart: BlackCat2412
Location: Vietnam
Contact:

Re: Ren'py documentation request

#6 Post by Black Cat 2412 » Tue Sep 12, 2017 9:44 am

Bump! This is absolutely necessary. I'm also a newbie and I 'm getting so much trouble when trying to implement any, ANY new code myself that does not have an example.

Post Reply

Who is online

Users browsing this forum: No registered users