mirror of
https://github.com/scrapy/scrapy.git
synced 2025-02-25 15:24:15 +00:00
docs: fix MailSender and Settings method references
--HG-- extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40748
This commit is contained in:
parent
3f13b388c7
commit
a29fed066c
@ -32,7 +32,7 @@ MailSender class reference
|
||||
MailSender is the preferred class to use for sending emails from Scrapy, as it
|
||||
uses `Twisted non-blocking IO`_, like the rest of the framework.
|
||||
|
||||
.. class:: scrapy.mail.MailSender(smtphost, mailfrom)
|
||||
.. class:: MailSender(smtphost, mailfrom)
|
||||
|
||||
``smtphost`` is a string with the SMTP host to use for sending the emails.
|
||||
If omitted, :setting:`MAIL_HOST` will be used.
|
||||
@ -40,7 +40,7 @@ uses `Twisted non-blocking IO`_, like the rest of the framework.
|
||||
``mailfrom`` is a string with the email address to use for sending messages
|
||||
(in the ``From:`` header). If omitted, :setting:`MAIL_FROM` will be used.
|
||||
|
||||
.. method:: send(to, subject, body, cc=None, attachs=())
|
||||
.. method:: MailSender.send(to, subject, body, cc=None, attachs=())
|
||||
|
||||
Send mail to the given recipients
|
||||
|
||||
|
@ -87,9 +87,9 @@ 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
|
||||
.. class:: Settings
|
||||
|
||||
.. method:: get(name, default=None)
|
||||
.. method:: Settings.get(name, default=None)
|
||||
|
||||
Get a setting value without affecting its original type.
|
||||
|
||||
@ -97,7 +97,7 @@ to do that you'll have to use one of the following methods:
|
||||
|
||||
``default`` is the value to return if no setting is found
|
||||
|
||||
.. method:: getbool(name, deafult=Flse)
|
||||
.. method:: Settings.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``
|
||||
@ -110,7 +110,7 @@ to do that you'll have to use one of the following methods:
|
||||
|
||||
``default`` is the value to return if no setting is found
|
||||
|
||||
.. method:: getint(name, default=0)
|
||||
.. method:: Settings.getint(name, default=0)
|
||||
|
||||
Get a setting value as an int
|
||||
|
||||
@ -118,7 +118,7 @@ to do that you'll have to use one of the following methods:
|
||||
|
||||
``default`` is the value to return if no setting is found
|
||||
|
||||
.. method:: getfloat(name, default=0.0)
|
||||
.. method:: Settings.getfloat(name, default=0.0)
|
||||
|
||||
Get a setting value as a float
|
||||
|
||||
@ -126,7 +126,7 @@ to do that you'll have to use one of the following methods:
|
||||
|
||||
``default`` is the value to return if no setting is found
|
||||
|
||||
.. method:: getlist(name, default=None)
|
||||
.. method:: Settings.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 ",".
|
||||
|
Loading…
x
Reference in New Issue
Block a user