# HG changeset patch
# User Sandro Knauß <knauss@netzguerilla.net>
# Date 1333021597 -7200
# Node ID 31114e40178d6fd06cb9c77206cee9eb5df6951b
# Parent  530d6283c0e3bb8504684746756f22fcb0a20148
iro.offer: adds docstrings

diff -r 530d6283c0e3 -r 31114e40178d iro/offer/__init__.py
--- a/iro/offer/__init__.py	Wed Mar 28 23:16:37 2012 +0200
+++ b/iro/offer/__init__.py	Thu Mar 29 13:46:37 2012 +0200
@@ -1,3 +1,12 @@
+"""Package all about providers. This packages handles the code for sending a message through a provider.
+
+- :attr:`iro.offer.provider.providers` -- a dict of all available providers
+- :func:`iro.offer.provider.getProvider` -- returns a object, from a provider name
+- :class:`iro.offer.provider.Provider` -- Baseclass for all providers
+- :class:`iro.offer.smtp.SMTP` -- a provider to send emails over smtp
+- :class:`iro.offer.smstrade.Smstrade` -- a provider to send sms via http://smstrade.de
+- :class:`iro.offer.offer.Offer` -- a represantation of an offer, this is used to send (see :mod:`iro.model.offer`).
+"""
 from .offer import Offer
 from .provider import Provider, providers, getProvider
 from .smtp import SMTP
diff -r 530d6283c0e3 -r 31114e40178d iro/offer/offer.py
--- a/iro/offer/offer.py	Wed Mar 28 23:16:37 2012 +0200
+++ b/iro/offer/offer.py	Thu Mar 29 13:46:37 2012 +0200
@@ -1,5 +1,21 @@
 class Offer():
+    """One Offer for sending.
+    This class is used to send a message via a provider.
+    """
     def __init__(self, name, provider, route, typ):
+        """ Constructor for Offer class.
+
+        :param string name: name is the name in database for the offer
+        :param `iro.offer.provider.Provider` provider: A valid provider object.
+        :param sting route: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
+        :param sting typ: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
+
+
+        .. automethod:: __call__
+        .. automethod:: __eq__
+        .. automethod:: __neq__
+        .. automethod:: __repr__
+        """
         self.name = name
         self.route = route
         self.provider = provider
@@ -7,14 +23,24 @@
         self.sendfunc = provider.getSendFunc(typ, route)
 
     def __call__(self, recipient, message):
+        """send a message to a recipient. This method uses :meth:`iro.offer.provider.Provider.send`
+
+        :param recipient: one recipient
+        :param `iro.model.message.Message` message: message to send
+        """
         return self.sendfunc(recipient, message)
 
     def __eq__(self,o):
+        """return ``True``, if o is equal."""
         return (self.name == o.name) and (self.route == o.route) and (self.provider == o.provider) and (self.typ == o.typ)
 
     def __neq__(self,o):
+        """return ``True``, if ``o`` is not equal (see :meth:`__eq__`)."""
         return not self.__eq__(o)
 
     def __repr__(self):
-        return "<Offer(%s,%s:%s,%s)>"%(self.name,self.provider,self.route,self.typ)
+        """string representation of this class for debugging purpose.
 
+        :return: ``<Offer(name, provider, route, typ)>`` """
+        return "<Offer(%s, %s, %s, %s)>"%(self.name,self.provider,self.route,self.typ)
+