From f676429e3ef0ef86db6da00cda15e3e925eddf05 Mon Sep 17 00:00:00 2001 From: Lauri Nevala Date: Thu, 25 Feb 2021 16:21:25 +0200 Subject: [PATCH] Update validateKubeConfig in-code documentation Signed-off-by: Lauri Nevala --- src/common/kube-helpers.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/common/kube-helpers.ts b/src/common/kube-helpers.ts index 3cf4fda6de..c2a2a8df93 100644 --- a/src/common/kube-helpers.ts +++ b/src/common/kube-helpers.ts @@ -157,8 +157,7 @@ export function getNodeWarningConditions(node: V1Node) { } /** - * Validates Context, User and Cluster sructs in given kubeconfig. Additionally this will validate - * the command passed to the exec substructure. + * Checks if `config` has valid `Context`, `User`, `Cluster`, and `exec` fields (if present when required) */ export function validateKubeConfig (config: KubeConfig, contextName: string, validationOpts: KubeConfigValidationOpts = {}) { // we only receive a single context, cluster & user object here so lets validate them as this