From 3fd8066a950063e7921064bab6fffd1c8c673e97 Mon Sep 17 00:00:00 2001 From: Megan Marsh Date: Tue, 15 Dec 2020 09:34:04 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Sylvia Moss --- packer-plugin-sdk/communicator/config.go | 2 +- packer-plugin-sdk/communicator/doc.go | 2 +- packer-plugin-sdk/net/configure_port.go | 2 +- packer-plugin-sdk/packer/doc.go | 2 +- packer-plugin-sdk/rpc/init.go | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packer-plugin-sdk/communicator/config.go b/packer-plugin-sdk/communicator/config.go index a6c1cb5f4..1d68e8120 100644 --- a/packer-plugin-sdk/communicator/config.go +++ b/packer-plugin-sdk/communicator/config.go @@ -24,7 +24,7 @@ import ( "golang.org/x/crypto/ssh/agent" ) -// Config is the common a builder uses to define and configure a Packer +// Config is the common configuration a builder uses to define and configure a Packer // communicator. Embed this struct in your builder config to implement // communicator support. type Config struct { diff --git a/packer-plugin-sdk/communicator/doc.go b/packer-plugin-sdk/communicator/doc.go index 30806b5d7..e5990c9a6 100644 --- a/packer-plugin-sdk/communicator/doc.go +++ b/packer-plugin-sdk/communicator/doc.go @@ -5,6 +5,6 @@ Normally, a builder will want to implement StepConnect, which is smart enough to then determine which kind of communicator, and therefore which kind of substep, it should implement. -Various helper functions are also supplied. CommHost +Various helper functions are also supplied. */ package communicator diff --git a/packer-plugin-sdk/net/configure_port.go b/packer-plugin-sdk/net/configure_port.go index ef8697a9a..16d830a02 100644 --- a/packer-plugin-sdk/net/configure_port.go +++ b/packer-plugin-sdk/net/configure_port.go @@ -1,4 +1,4 @@ -// package net contains some helper wrapping functions for the http and net +// Package net contains some helper wrapping functions for the http and net // golang libraries that meet Packer-specific needs. package net diff --git a/packer-plugin-sdk/packer/doc.go b/packer-plugin-sdk/packer/doc.go index c82c2fa6e..ada2bbd4c 100644 --- a/packer-plugin-sdk/packer/doc.go +++ b/packer-plugin-sdk/packer/doc.go @@ -11,7 +11,7 @@ absolutely necessary. Plugins will need to implement either the Builder, Provisioner, or Post-Processor interfaces, and will likely create an Artifact. The -Communicator must be implemented in the Builder and is then passed into the +Communicator must be implemented in the Builder and then passed into the Provisioners so they can use it communicate with the instance without needing to know the connection details. diff --git a/packer-plugin-sdk/rpc/init.go b/packer-plugin-sdk/rpc/init.go index 54ff2aca7..eeeb9e0c1 100644 --- a/packer-plugin-sdk/rpc/init.go +++ b/packer-plugin-sdk/rpc/init.go @@ -1,7 +1,7 @@ /* Package rpc contains the implementation of the remote procedure call code that the Packer core uses to communicate with packer plugins. As a plugin maintainer, -You are unlikely to need to directly import or use this package, but it +you are unlikely to need to directly import or use this package, but it underpins the packer server that all plugins must implement. */ package rpc