diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/mutual_friends.md | 18 |
1 files changed, 7 insertions, 11 deletions
diff --git a/docs/mutual_friends.md b/docs/mutual_friends.md index cc9396e..4e0e4b4 100644 --- a/docs/mutual_friends.md +++ b/docs/mutual_friends.md @@ -6,23 +6,21 @@ Learn who your ex and her new boyfriend are both friends with. Usage ----- -Run from the top-level directory using `python -m`. -For example: +Run from the top-level directory using `python -m`: > python -m bin.mutual_friends -h - usage: mutual_friends.py [-h] [--output-format {csv,json}] UID [UID ...] + usage: mutual_friends.py [-h] [--output-format {csv,json}] [--output OUTPUT] + UID [UID ...] ... For example (using made up user IDs/"screen names"), > python -m bin.mutual_friends john.doe jane.doe - 89497105,John,Smith,john.smith - 3698577,Jane,Smith,jane.smith + 89497105,John,Smith + 3698577,Jane,Smith In the example above, both "John Doe" and "Jane Doe" are friends with "John Smith" and "Jane Smith", whose user IDs are 89497105 and 3698577 respectively. -Their "screen names" (the part after "vk.com/" of their personal page URLs) are -"john.smith" and "jane.smith". The output format is CSV (comma-separated values) by default. You can also get a JSON document: @@ -32,14 +30,12 @@ You can also get a JSON document: { "uid": 89497105, "first_name": "John", - "last_name": "Smith", - "screen_name": "john.smith" + "last_name": "Smith" }, { "uid": 3698577, "first_name": "Jane", - "last_name": "Smith", - "screen_name": "jane.smith" + "last_name": "Smith" } ] |