From 04fe3132ce4482ff9741b80c5e034f6fef155af6 Mon Sep 17 00:00:00 2001 From: Adam Wardecki Date: Fri, 16 Sep 2016 17:01:08 +0200 Subject: [PATCH] Improve docstrings --- syncano_cli/base/exceptions.py | 4 ++-- syncano_cli/custom_sockets/commands.py | 2 +- syncano_cli/instance/commands.py | 4 +++- syncano_cli/parse_to_syncano/commands.py | 6 +++--- syncano_cli/sync/commands.py | 2 +- 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/syncano_cli/base/exceptions.py b/syncano_cli/base/exceptions.py index 74fdfe8..b204bd2 100644 --- a/syncano_cli/base/exceptions.py +++ b/syncano_cli/base/exceptions.py @@ -23,11 +23,11 @@ class JSONParseException(CLIBaseException): class BadCredentialsException(CLIBaseException): - default_message = u'Wrong credential provided when login.' + default_message = u'Wrong login credentials provided.' class NotLoggedInException(CLIBaseException): - default_message = u'Do a login first: `syncano login`.' + default_message = u'Please log in to your account: `syncano login`.' class InstanceNotFoundException(CLIBaseException): diff --git a/syncano_cli/custom_sockets/commands.py b/syncano_cli/custom_sockets/commands.py index 659c6e7..11bb864 100644 --- a/syncano_cli/custom_sockets/commands.py +++ b/syncano_cli/custom_sockets/commands.py @@ -18,7 +18,7 @@ def top_sockets(): @click.option('--instance-name', help=u'Instance name.') def sockets(ctx, config, instance_name): """ - Allow to create a custom socket. + Create and manage custom sockets. """ instance = get_instance(config, instance_name) socket_command = SocketCommand(instance=instance) diff --git a/syncano_cli/instance/commands.py b/syncano_cli/instance/commands.py index 1baa320..fab87bf 100644 --- a/syncano_cli/instance/commands.py +++ b/syncano_cli/instance/commands.py @@ -18,7 +18,9 @@ def top_instance(): @click.option('--instance-name', help=u'Instance name.') def instances(ctx, config, instance_name): """ - Handle hosting and hosting files. Allow to publish static pages to the Syncano Hosting. + Mangage your Instances. Instance is an equivalent of a project or a set of data. + It contains information about Sockets, Data Classes, Data Objects and more. + You can own and/or belong to multiple instances. """ connection = create_connection(config, instance_name) instance_commands = InstanceCommands(connection) diff --git a/syncano_cli/parse_to_syncano/commands.py b/syncano_cli/parse_to_syncano/commands.py index 606a53c..1dbd880 100644 --- a/syncano_cli/parse_to_syncano/commands.py +++ b/syncano_cli/parse_to_syncano/commands.py @@ -16,7 +16,7 @@ def top_migrate(): @click.option('--config', help=u'Account configuration file.') def migrate(context, config): """ - Command for transfer data to Syncano + Migrate Parse data to Syncano """ config = config or ACCOUNT_CONFIG_PATH context.obj['config'] = config @@ -26,7 +26,7 @@ def migrate(context, config): @click.pass_context def parse(context): """ - Synchronize the parse data object with syncano data objects; + Synchronize the Parse data objects with Syncano data objects; """ config = read_config(config_path=context.obj['config']) check_configuration(config, silent=True) @@ -53,7 +53,7 @@ def parse(context): @click.option('--force', is_flag=True, default=False, help="Force to overwrite previous config.") def configure(context, current, force): """ - Configure the data needed for connection to the parse and syncano; + Configure the data needed for connection between Parse and Syncano; """ config = read_config(config_path=context.obj['config']) if current: diff --git a/syncano_cli/sync/commands.py b/syncano_cli/sync/commands.py index 1c13c44..e90113b 100644 --- a/syncano_cli/sync/commands.py +++ b/syncano_cli/sync/commands.py @@ -23,7 +23,7 @@ def top_sync(): @click.option('--instance-name', help=u'Instance name.') def sync(context, file, config, instance_name): """ - Command for syncing data - classes and scripts + Sync your scripts and data classes. :param context: :param file: file which will be used for syncing :param config: the config path - the cli config will be stored there