Skip to content

Commit

Permalink
Couple corrections on README
Browse files Browse the repository at this point in the history
  • Loading branch information
Paddy Foran committed Mar 27, 2013
1 parent 20f7cc0 commit c01d648
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -78,8 +78,10 @@ queue.post(*[str(i) for i in range(10)])

### **Pop** a message off the queue:
```python
queue.get()
queue.get(max=10) # {"messages": [{'id': '..', 'body': '..'}, ..]}
```
Set max to the number of messages to return, 1 by default.

When you pop/get a message from the queue, it will NOT be deleted.
It will eventually go back onto the queue after a timeout if you don't delete it (default timeout is 60 seconds).
### **Delete** a message from the queue:
Expand Down Expand Up @@ -111,7 +113,7 @@ queue.id() # u'502d03d3211a8f5e7742d224'
To view messages without reserving them, use peek:

```python
msgs = queue.peek(max=10) [{'id': '..', 'body': '..'}, ..]
msgs = queue.peek(max=10) # {"messages": [{'id': '..', 'body': '..'}, ..]}
```

### Touch a message
Expand Down

0 comments on commit c01d648

Please sign in to comment.