diff options
author | zhu.fanglei <zhu.fanglei@zte.com.cn> | 2019-06-14 11:45:11 +0800 |
---|---|---|
committer | zhu.fanglei <zhu.fanglei@zte.com.cn> | 2019-06-14 14:23:57 +0800 |
commit | 43f7bf9f0b3c12e94c6da3f3065c599f5c1055d9 (patch) | |
tree | e63be646b7a00914ba0635787835b159d7a6f6a8 /ironic/cmd | |
parent | 7d204b656895b0512069ba3b3a23ec5bc394a727 (diff) | |
download | ironic-43f7bf9f0b3c12e94c6da3f3065c599f5c1055d9.tar.gz |
Fix :param: in docstring
In docstring :param should be used instead of :param:.
Change-Id: Id531e58087b8196b30dda12aa4245a1eefd638ac
Diffstat (limited to 'ironic/cmd')
-rw-r--r-- | ironic/cmd/dbsync.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/ironic/cmd/dbsync.py b/ironic/cmd/dbsync.py index 21e59dc29..4712a3e8a 100644 --- a/ironic/cmd/dbsync.py +++ b/ironic/cmd/dbsync.py @@ -169,10 +169,10 @@ class DBCommand(object): specified max_count. A migration of an object will typically migrate one row of data inside the database. - :param: context: an admin context - :param: max_count: the maximum number of objects (rows) to migrate; + :param context: an admin context + :param max_count: the maximum number of objects (rows) to migrate; a value >= 1. - :param: options: migration options - dict mapping migration name + :param options: migration options - dict mapping migration name to a dictionary of options for this migration. :raises: Exception from the migration function :returns: Boolean value indicating whether migrations are done. Returns @@ -226,10 +226,10 @@ class DBCommand(object): migrations are done. Otherwise, this will run (some of) the functions until max_count objects have been migrated. - :param: max_count: the maximum number of individual object migrations + :param max_count: the maximum number of individual object migrations or modified rows, a value >= 1. If None, migrations are run in a loop in batches of 50, until completion. - :param: options: options to pass to migrations. List of values in the + :param options: options to pass to migrations. List of values in the form of <migration name>.<option>=<value> :raises: SystemExit. With exit code of: 0: when all migrations are complete. |