Updated manual
authorMarek Marecki <triviuss@gmail.com>
Tue, 30 Apr 2013 21:09:20 +0000 (23:09 +0200)
committerMarek Marecki <triviuss@gmail.com>
Tue, 30 Apr 2013 21:09:20 +0000 (23:09 +0200)
manual/connecting_to_pod.mdown
manual/connection.mdown
manual/stream.mdown

index 9c2de82902ccb559056e2d2990194a256bdf5bd7..5bfe50af974019ec3626ea9fea1308e2a04fa47f 100644 (file)
@@ -10,3 +10,7 @@ Then, if no errors are raised, you can `_login()` to the pod with given username
 
 
 If everything worked you are now connected to D\* pod at given URL.
+
+----
+
+###### Manual for `diaspy`, written by Marek Marecki
index f5219a9b11a9eb665735d95d7e8237bc060f364a..723ba82a6dc53276f673bbb75f012ed7af03bf1e 100644 (file)
@@ -80,3 +80,6 @@ connection is broken.
 If you want to write your own interface or client for D\* 
 `Connection()` will be the only object you need.
 
+----
+
+###### Manual for `diaspy`, written by Marek Marecki
index 7be4c36cea39588d638d3002e3e9b63302dadb38..eca267771689fe76f7c914e611a85317612171cc 100644 (file)
@@ -24,9 +24,37 @@ Now you have a stream filled with posts (if any can be found on user's stream).
 
 ----
 
-##### Length of a stream
+##### `fill()` and `update()`
+
+When you want to refresh stream call it's `fill()` method. It will overwrite old stream 
+contents.
+
+On the contrary, `update()` will get a new stream but will not overwrite old stream saved 
+in the object memory. It will append every new post to the old stream.
+
+----
+
+##### Length of and iterating over a stream
 
 Stream's length can be checked by calling `len()` on it.
 
     len(stream)
     10
+
+When you want to iterate over a stream (e.g. when you want to print first *n* posts on 
+the stream) you can do it in two ways.
+
+First, using `len()` and `range()` functions.
+
+    for i in range(len(stream)):
+        # do stuff...
+
+Second, iterating directly over the stream contents:
+
+    for post in stream:
+        # do stuff...
+
+
+----
+
+###### Manual for `diaspy`, written by Marek Marecki