aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-06-20 04:55:02 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-06-20 04:55:02 +0300
commitf7763db46afdd4834095325643624b1e287b445c (patch)
tree1b5c2618ce81683966d5f84ef4bec2e0eda56128 /docs
parentonline_duration.py: refactoring + Pylint fixes (diff)
downloadvk-scripts-f7763db46afdd4834095325643624b1e287b445c.tar.gz
vk-scripts-f7763db46afdd4834095325643624b1e287b445c.zip
docs: update
Diffstat (limited to '')
-rw-r--r--docs/mutual_friends.md2
-rw-r--r--docs/online_duration.md18
-rw-r--r--docs/track_status.md7
3 files changed, 12 insertions, 15 deletions
diff --git a/docs/mutual_friends.md b/docs/mutual_friends.md
index 4e0e4b4..10c1218 100644
--- a/docs/mutual_friends.md
+++ b/docs/mutual_friends.md
@@ -9,7 +9,7 @@ Usage
Run from the top-level directory using `python -m`:
> python -m bin.mutual_friends -h
- usage: mutual_friends.py [-h] [--output-format {csv,json}] [--output OUTPUT]
+ usage: mutual_friends.py [-h] [--output-format {csv,json}] [-o PATH]
UID [UID ...]
...
diff --git a/docs/online_duration.md b/docs/online_duration.md
index 22af4b1..6076d18 100644
--- a/docs/online_duration.md
+++ b/docs/online_duration.md
@@ -6,13 +6,12 @@ View/visualize the amount of time people spend online.
Usage
-----
-Run from the top-level directory using `python -m`.
-For example:
+Run from the top-level directory using `python -m`:
> python -m bin.online_duration -h
usage: online_duration.py [-h] [--grouping {user,date,weekday,hour}]
[--input-format {csv,log,null}]
- [--output-format {csv,json,img}] [--from DATE_FROM]
+ [--output-format {csv,json,plot}] [--from DATE_FROM]
[--to DATE_TO]
input [output]
@@ -20,7 +19,6 @@ This script additionally requires [matplotlib] to be installed.
Analyze the database produced by [track_status.py] and calculate the total
amount of time people spent online.
-
For example (assuming the database in "db.csv" was generated by
[track_status.py] before):
@@ -109,23 +107,23 @@ Sunday,0:00:00
```
In my opinion, the script's most useful feature is the ability to easily create
-plots that represent the text data (like in the examples above).
-To produce a plot, pass `img` as the `--output-format` parameter value and add
+plots that represent this data (like in the examples above).
+To produce a plot, pass `plot` as the `--output-format` parameter value and add
a file path to write the image to.
- > python -m bin.online_duration --output-format img db.csv user.png
+ > python -m bin.online_duration --output-format plot db.csv user.png
![user.png]
- > python -m bin.online_duration --output-format img --grouping date db.csv date.png
+ > python -m bin.online_duration --output-format plot --grouping date db.csv date.png
![date.png]
- > python -m bin.online_duration --output-format img --grouping weekday db.csv weekday.png
+ > python -m bin.online_duration --output-format plot --grouping weekday db.csv weekday.png
![weekday.png]
- > python -m bin.online_duration --output-format img --grouping hour db.csv hour.png
+ > python -m bin.online_duration --output-format plot --grouping hour db.csv hour.png
![hour.png]
diff --git a/docs/track_status.md b/docs/track_status.md
index 0800b44..bf3759e 100644
--- a/docs/track_status.md
+++ b/docs/track_status.md
@@ -6,12 +6,11 @@ Track when people go online/offline.
Usage
-----
-Run from the top-level directory using `python -m`.
-For example:
+Run from the top-level directory using `python -m`:
> python -m bin.track_status -h
- usage: track_status.py [-h] [-t TIMEOUT] [-l LOG]
- [--output-format {csv,log,null}] [-o OUTPUT]
+ usage: track_status.py [-h] [-t SECONDS] [-l PATH]
+ [--output-format {csv,log,null}] [-o PATH]
UID [UID ...]
...