Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
heynemann committed Nov 20, 2013
1 parent a51e433 commit 21d0c7a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,10 @@ Octopus.start()

If `auto_start` is set to `False`, this method must be called to start retrieving URLs. This is a **non-blocking** method.

Octopus.enqueue(url, handler, method="GET", **kwargs)
-----------------------------------------------------
Octopus.enqueue
---------------

Takes as arguments (url, handler, method="GET", **kwargs).

This is the main method in the `Octopus` class. This method is used to enqueue new URLs. The handler argument specifies the method to be called when the response is available.

Expand Down Expand Up @@ -156,8 +158,10 @@ TornadoOctopus.start()

If `auto_start` is set to `False`, this method must be called to create the IOLoop instance. This is a **non-blocking** method.

TornadoOctopus.enqueue(url, handler, method="GET", **kwargs)
------------------------------------------------------------
TornadoOctopus.enqueue
----------------------

Takes as arguments (url, handler, method="GET", **kwargs).

This is the main method in the `TornadoOctopus` class. This method is used to enqueue new URLs. The handler argument specifies the method to be called when the response is available.

Expand Down

0 comments on commit 21d0c7a

Please sign in to comment.