Skip to content

Commit bbc2121

Browse files
committed
fixed docs
1 parent 52702f7 commit bbc2121

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

docs/api.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -669,22 +669,18 @@ None
669669
The Docker API parallel to the `docker stats` command.
670670
This will stream statistics for a specific container.
671671

672-
`aggregate`, if 0 will return an iterable stream object of messages.
673-
If aggregate is above 0, an iterable stream object of a list of messages in the size of `aggregate` will be returned.
674-
675672
**Params**:
676673

677674
* container (str): The container to start
678675
* aggregate (int): The number of messages to aggregate before returning a stream object.
679676

680677
```python
681678
>>> from docker import Client
682-
>>> aggregate = 10
683679
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
684-
>>> stats_obj = cli.stats('elasticsearch', aggregate=aggregate)
680+
>>> stats_obj = cli.stats('elasticsearch')
685681
>>> for stat in stats:
686682
>>> print(stat)
687-
['{"read":"2015-02-11T21:47:30.49388286+02:00","network":{"rx_bytes":666052,"rx_packets":4409 ...
683+
{"read":"2015-02-11T21:47:30.49388286+02:00","network":{"rx_bytes":666052,"rx_packets":4409 ...
688684
...
689685
...
690686
...

0 commit comments

Comments
 (0)