Documentation about image subdirectories is misleading

Bug #1738698 reported by Cowlinator
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ren'Py
New
Undecided
Unassigned

Bug Description

https://www.renpy.org/doc/html/displaying_images.html
shows how "eileen happy" is defined by all of the files
game/images/eileen happy.png
game/images/Eileen Happy.jpg
game/images/eileen/eileen happy.png

This is correct.

The next section show how to define an image using an actual filename.

In this section there are no statements about, nor examples of, subdirectories. It is therefore implied that it will follow the rules above; e.g.
image eileen happy = "eileen_happy.png"
is defined by all of the files
game/images/eileen happy.png
game/images/Eileen Happy.jpg
game/images/eileen/eileen happy.png

This is incorrect.

Please don't make this implication.
Please explicitly explain in your documentation that
game/images/eileen/eileen happy.png
can only be defined by
image eileen happy = "eileen/eileen happy.png"

Revision history for this message
Tom Rothamel (renpytom) wrote :

Hi there.

I can certainly make that change to the documentation.

Can you file a bug at the current Ren'Py issue tracker, https://github.com/renpy/renpy/issues ?

Thank you.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.