docs: Update docs

README.md

@@ -130,12 +130,13 @@ Commands:
                         Automatically purge completed/removed/failed
                         downloads.
     call                Call a remote method through the JSON-RPC client.
-    pause               Pause downloads.
+    pause (stop)        Pause downloads.
     pause-all           Pause all downloads.
     purge (clear)       Purge downloads.
-    remove (rm)         Remove downloads.
+    remove (rm, del, delete)
+                        Remove downloads.
     remove-all          Remove all downloads.
-    resume              Resume downloads.
+    resume (start)      Resume downloads.
     resume-all          Resume all downloads.
     show                Show the download progression.
 
@@ -175,6 +176,8 @@ Commands:
 (e.g. instead of `pause-all`, use `pause -a`). These commands will be removed in version 0.5.0.
 
 
+---
+
 ### `add-magnet`
 ```
 usage: aria2p add-magnet [-h] uri
@@ -191,6 +194,8 @@ optional arguments:
 
 
 
+---
+
 ### `add-metalink`
 ```
 usage: aria2p add-metalink [-h] metalink_file
@@ -207,6 +212,8 @@ optional arguments:
 
 
 
+---
+
 ### `add-torrent`
 ```
 usage: aria2p add-torrent [-h] torrent_file
@@ -223,6 +230,8 @@ optional arguments:
 
 
 
+---
+
 ### `autopurge`
 ```
 usage: aria2p autopurge [-h]
@@ -236,6 +245,8 @@ optional arguments:
 
 
 
+---
+
 ### `call`
 ```
 usage: aria2p call [-h] [-P PARAMS [PARAMS ...] | -J PARAMS] method
@@ -347,6 +358,8 @@ $ aria2p call purge_download_result
 ```
 
 
+---
+
 ### `pause`
 ```
 usage: aria2p pause [-h] [-a] [-f] [gids [gids ...]]
@@ -365,6 +378,8 @@ optional arguments:
 
 
 
+---
+
 ### `pause-all`
 ```
 usage: aria2p pause-all [-h] [-f]
@@ -379,6 +394,8 @@ optional arguments:
 
 
 
+---
+
 ### `purge`
 ```
 usage: aria2p purge [-h] [-a] [gids [gids ...]]
@@ -396,6 +413,8 @@ optional arguments:
 
 
 
+---
+
 ### `remove`
 ```
 usage: aria2p remove [-h] [-a] [-f] [gids [gids ...]]
@@ -414,6 +433,8 @@ optional arguments:
 
 
 
+---
+
 ### `remove-all`
 ```
 usage: aria2p remove-all [-h] [-f]
@@ -428,6 +449,8 @@ optional arguments:
 
 
 
+---
+
 ### `resume`
 ```
 usage: aria2p resume [-h] [-a] [gids [gids ...]]
@@ -445,6 +468,8 @@ optional arguments:
 
 
 
+---
+
 ### `resume-all`
 ```
 usage: aria2p resume-all [-h]
@@ -458,6 +483,8 @@ optional arguments:
 
 
 
+---
+
 ### `show`
 ```
 usage: aria2p show [-h]

scripts/gen-readme-data.py

@@ -7,7 +7,7 @@
 
 parser = get_parser()
 
-aliases = ["autoclear", "clear", "rm"]
+aliases = ["autoclear", "clear", "rm", "del", "delete", "start", "stop"]
 
 output = {"main_usage": parser.format_help(), "commands": []}
 

scripts/templates/README.md

@@ -70,10 +70,9 @@ With `pip`:
 python3.6 -m pip install aria2p
 ```
 
-With [`pipx`](https://github.com/cs01/pipx):
+With [`pipx`](https://github.com/pipxproject/pipx):
 ```bash
-# install pipx with the recommended method
-curl https://raw.githubusercontent.com/cs01/pipx/master/get-pipx.py | python3
+python3.6 -m pip install --user pipx
 
 pipx install --python python3.6 aria2p
 ```
@@ -132,6 +131,8 @@ Commands:
 (e.g. instead of `pause-all`, use `pause -a`). These commands will be removed in version 0.5.0.
 
 {% for command in commands %}
+---
+
 ### `{{ command.name }}`
 ```
 {{ command.usage }}

src/aria2p/api.py

@@ -208,7 +208,7 @@ def get_download(self, gid):
 
     def get_downloads(self, gids=None):
         """
-        Get a list :class:`~aria2p.downloads.Download` object thanks to their GIDs.
+        Get a list of :class:`~aria2p.downloads.Download` object thanks to their GIDs.
 
         Args:
             gids (list of str): the GIDs of the downloads to get. If None, return all the downloads.