From f6a3db9c6d4e3c9cdf4bed5c14757173d915b3d6 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Tue, 19 Dec 2023 00:34:33 -0500 Subject: [PATCH] docs: fix docblock entries for properties in plugins --- plugins/app-json/appjson.go | 4 ++-- plugins/apps/apps.go | 4 ++-- plugins/builder/builder.go | 4 ++-- plugins/cron/cron.go | 4 ++-- plugins/registry/registry.go | 4 ++-- plugins/scheduler/scheduler.go | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/plugins/app-json/appjson.go b/plugins/app-json/appjson.go index 73aa402fe..dcdb7e92c 100644 --- a/plugins/app-json/appjson.go +++ b/plugins/app-json/appjson.go @@ -5,12 +5,12 @@ import ( ) var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid app-json properties with corresponding default property values DefaultProperties = map[string]string{ "appjson-path": "", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global app-json properties GlobalProperties = map[string]bool{ "appjson-path": true, } diff --git a/plugins/apps/apps.go b/plugins/apps/apps.go index 3369609ca..3259c6d4c 100644 --- a/plugins/apps/apps.go +++ b/plugins/apps/apps.go @@ -1,13 +1,13 @@ package apps var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid apps properties with corresponding default property values DefaultProperties = map[string]string{ "deploy-source": "", "deploy-source-metadata": "", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global apps properties GlobalProperties = map[string]bool{ "deploy-source": true, "deploy-source-metadata": true, diff --git a/plugins/builder/builder.go b/plugins/builder/builder.go index 3d1a6d6f8..d4c390772 100644 --- a/plugins/builder/builder.go +++ b/plugins/builder/builder.go @@ -1,13 +1,13 @@ package builder var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid builder properties with corresponding default property values DefaultProperties = map[string]string{ "selected": "", "build-dir": "", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global builder properties GlobalProperties = map[string]bool{ "selected": true, "build-dir": true, diff --git a/plugins/cron/cron.go b/plugins/cron/cron.go index 35eb42078..90a64251a 100644 --- a/plugins/cron/cron.go +++ b/plugins/cron/cron.go @@ -14,12 +14,12 @@ import ( ) var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid cron properties with corresponding default property values DefaultProperties = map[string]string{ "mailto": "", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global cron properties GlobalProperties = map[string]bool{ "mailto": true, } diff --git a/plugins/registry/registry.go b/plugins/registry/registry.go index 301219437..9472faefb 100644 --- a/plugins/registry/registry.go +++ b/plugins/registry/registry.go @@ -1,14 +1,14 @@ package registry var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid registry properties with corresponding default property values DefaultProperties = map[string]string{ "image-repo": "", "push-on-release": "false", "server": "", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global registry properties GlobalProperties = map[string]bool{ "push-on-release": true, "server": true, diff --git a/plugins/scheduler/scheduler.go b/plugins/scheduler/scheduler.go index 951836ac1..1bd7c0371 100644 --- a/plugins/scheduler/scheduler.go +++ b/plugins/scheduler/scheduler.go @@ -1,12 +1,12 @@ package scheduler var ( - // DefaultProperties is a map of all valid network properties with corresponding default property values + // DefaultProperties is a map of all valid scheduler properties with corresponding default property values DefaultProperties = map[string]string{ "selected": "docker-local", } - // GlobalProperties is a map of all valid global network properties + // GlobalProperties is a map of all valid global scheduler properties GlobalProperties = map[string]bool{ "selected": true, }