0

Stop auto-correcting incorrect slashes. Instead error, and point to our docs.

Also, improve docs slightly to say to *always* use forward slashes

See #906
This commit is contained in:
Andrew Chin
2013-03-15 20:53:24 -04:00
parent 52e3773b79
commit 2ea1f061ea
2 changed files with 34 additions and 29 deletions

View File

@@ -10,10 +10,15 @@ like this::
overviewer.py --config=path/to/my_configfile
The config file is formatted in Python syntax. If you aren't familiar with
Python, don't worry, it's pretty simple. Just follow the examples.
.. note::
You should *always* use forward slashes ("/"), even on
Windows. This is required because the backslash ("\\") has special meaning
in Python.
A Simple Example
================
@@ -193,6 +198,8 @@ the form ``key = value``. Two items take a different form:, ``worlds`` and
**You must specify at least one world**
*Reminder*: Always use forward slashes ("/"), even on Windows.
``renders``
This is also pre-defined as an empty dictionary. The config file is expected
to add at least one item to it.
@@ -226,6 +233,8 @@ the form ``key = value``. Two items take a different form:, ``worlds`` and
outputdir = "/path/to/output"
*Reminder*: Always use forward slashes ("/"), even on Windows.
**Required**
.. _processes: