From dd345980a5415e818300b3c275c7c1a22c44f15d Mon Sep 17 00:00:00 2001 From: Andrew Chin Date: Sat, 22 Sep 2012 17:50:23 -0400 Subject: [PATCH] Clarified docs on overlay option Closes #789 --- docs/config.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/config.rst b/docs/config.rst index e3fc8e5..3238995 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -640,7 +640,11 @@ values. The valid configuration keys are listed below. ``overlay`` This specifies which renders that this render will be displayed on top of. - It should be a list of other renders. + It should be a list of other renders. If this option is confusing, think + of this option's name as "overlay_on_to". + + If you leave this as an empty list, this overlay will be displayed on top + of all renders for the same world/dimension as this one. **Default:** ``[]`` (an empty list)