From 97705b920d8330e3cb115fb9a04f041509520171 Mon Sep 17 00:00:00 2001 From: Mark Henderson Date: Mon, 7 Dec 2015 16:35:52 -0500 Subject: [PATCH] Update options.py It is unclear in the documentation what tornado.options.parse_config_file does and how it works. I added a little text to the copy that should clarify its purpose. --- tornado/options.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tornado/options.py b/tornado/options.py index bdb5baa0a..5477f833f 100644 --- a/tornado/options.py +++ b/tornado/options.py @@ -41,6 +41,13 @@ either:: # or tornado.options.parse_config_file("/etc/server.conf") +.. note: + + When using tornado.options.parse_config_file(), the only options that are set + are ones that were previously defined either tornado.options.parse_command_line + or tornado.options.define. torndo.options.parse_config_file is used mainly as a + means to offer overriding settings for different environments. + Command line formats are what you would expect (``--myoption=myvalue``). Config files are just Python files. Global names become options, e.g.:: -- 2.47.2