From 1f488a8bfd391f677230c91e1fdfc1ad7034e88d Mon Sep 17 00:00:00 2001 From: Gavin D'souza Date: Mon, 17 Feb 2020 17:22:30 +0530 Subject: [PATCH] docs: bench.command.make added help for make commands --- bench/commands/make.py | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/bench/commands/make.py b/bench/commands/make.py index b9b01b3e..f6ba1377 100755 --- a/bench/commands/make.py +++ b/bench/commands/make.py @@ -1,6 +1,8 @@ +# imports - third party imports import click -@click.command() + +@click.command('init', help='Initialize a new bench instance in the specified path') @click.argument('path') @click.option('--python', type = str, default = 'python3', help = 'Path to Python Executable.') @click.option('--ignore-exist', is_flag = True, default = False, help = "Ignore if Bench instance exists.") @@ -16,9 +18,6 @@ import click @click.option('--skip-assets',is_flag=True, default=False, help="Do not build assets") @click.option('--verbose',is_flag=True, help="Verbose output during install") def init(path, apps_path, frappe_path, frappe_branch, no_procfile, no_backups, no_auto_update, clone_from, verbose, skip_redis_config_generation, clone_without_update, ignore_exist=False, skip_assets=False, python='python3'): - ''' - Create a New Bench Instance. - ''' from bench.utils import init, log try: @@ -52,42 +51,38 @@ def init(path, apps_path, frappe_path, frappe_branch, no_procfile, no_backups, n shutil.rmtree(path) -@click.command('get-app') +@click.command('get-app', help='Clone an app from the internet or filesystem and set it up in your bench') @click.argument('name', nargs=-1) # Dummy argument for backward compatibility @click.argument('git-url') @click.option('--branch', default=None, help="branch to checkout") @click.option('--skip-assets', is_flag=True, default=False, help="Do not build assets") def get_app(git_url, branch, name=None, skip_assets=False): - "clone an app from the internet and set it up in your bench" from bench.app import get_app get_app(git_url, branch=branch, skip_assets=skip_assets) -@click.command('new-app') +@click.command('new-app', help='Create a new Frappe application under apps folder') @click.argument('app-name') def new_app(app_name): - "start a new app" from bench.app import new_app new_app(app_name) -@click.command('remove-app') +@click.command('remove-app', help='Completely remove app from bench and re-build assets if not installed on any site') @click.argument('app-name') def remove_app(app_name): - "completely remove app from bench" from bench.app import remove_app remove_app(app_name) -@click.command('exclude-app') +@click.command('exclude-app', help='Exclude app from updating') @click.argument('app_name') def exclude_app_for_update(app_name): - "Exclude app from updating" from bench.app import add_to_excluded_apps_txt add_to_excluded_apps_txt(app_name) -@click.command('include-app') +@click.command('include-app', help='Include app for updating') @click.argument('app_name') def include_app_for_update(app_name): "Include app from updating"