From 73074721de422c95ed6040f0b6a277486bd86fd1 Mon Sep 17 00:00:00 2001
From: Pablo Hoffman <pablo@pablohoffman.com>
Date: Sun, 11 Jan 2009 20:04:13 +0000
Subject: [PATCH] improved settings doc

--HG--
extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40706
---
 scrapy/trunk/docs/topics/settings.rst | 64 +++++++++++++++++++++++++--
 1 file changed, 61 insertions(+), 3 deletions(-)

diff --git a/scrapy/trunk/docs/topics/settings.rst b/scrapy/trunk/docs/topics/settings.rst
index 0e6ed3652..95522d8a2 100644
--- a/scrapy/trunk/docs/topics/settings.rst
+++ b/scrapy/trunk/docs/topics/settings.rst
@@ -4,6 +4,9 @@
 Settings
 ========
 
+.. module:: scrapy.conf
+   :synopsis: Settings manager
+
 The Scrapy settings allows you to customize the behaviour of all Scrapy
 components, including the core, extensions, pipelines and spiders themselves.
 
@@ -74,14 +77,69 @@ How to access settings
 
 .. highlight:: python
 
-To access settings from Python code::
+Here's an example of the simplest way to access settings from Python code::
 
    >>> from scrapy.conf import settings
    >>> print settings['LOG_ENABLED']
    True
 
-Available settings
-==================
+In other words, settings can be accesed like a dict, but it's usually preferred
+to extract the setting in the format you need it to avoid type errors. In order
+to do that you'll have to use one of the following methods:
+
+.. class:: scrapy.conf.Settings
+
+.. method:: get(name, default=None)
+
+   Get a setting value without affecting its original type.
+
+   ``name`` is a string with the setting name
+
+   ``default`` is the value to return if no setting is found
+
+.. method:: getbool(name, deafult=Flse)
+
+   Get a setting value as a boolean. For example, both ``1`` and ``'1'``, and
+   ``True`` return ``True``, while ``0``, ``'0'``, ``False`` and ``None``
+   return ``False````
+
+   For example, settings populated through environment variables set to ``'0'``
+   will return ``False`` when using this method.
+
+   ``name`` is a string with the setting name
+
+   ``default`` is the value to return if no setting is found
+
+.. method:: getint(name, default=0)
+
+   Get a setting value as an int
+
+   ``name`` is a string with the setting name
+
+   ``default`` is the value to return if no setting is found
+
+.. method:: getfloat(name, default=0.0)
+
+   Get a setting value as a float
+
+   ``name`` is a string with the setting name
+
+   ``default`` is the value to return if no setting is found
+
+.. method:: getlist(name, default=None)
+
+   Get a setting value as a list. If the setting original type is a list it
+   will be returned verbatim. If it's a string it will be splitted by ",".
+
+   For example, settings populated through environment variables set to
+   ``'one,two'`` will return a list ['one', 'two'] when using this method.
+
+   ``name`` is a string with the setting name
+
+   ``default`` is the value to return if no setting is found
+
+Available built-in settings
+===========================
 
 See :ref:`settings`.