From 3fca96e0ef2b98e26f52276e99845793f215dd38 Mon Sep 17 00:00:00 2001 From: Ron Evans Date: Thu, 17 Oct 2019 11:50:03 +0200 Subject: [PATCH] docs: complete missing GoDocs for main and sub-packages Signed-off-by: Ron Evans --- drivers.go | 6 +++--- easystepper/easystepper.go | 2 +- espat/mqtt/mqtt.go | 2 ++ 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/drivers.go b/drivers.go index fa04526..d0a2577 100644 --- a/drivers.go +++ b/drivers.go @@ -1,5 +1,5 @@ -// Package drivers provides a collection of hardware drivers for devices that -// can be used together with TinyGo (https://tinygo.org). +// Package drivers provides a collection of hardware drivers for TinyGo (https://tinygo.org) +// for devices such as sensors and displays. // // Here is an example in TinyGo that uses the BMP180 digital barometer: // @@ -9,7 +9,7 @@ // "time" // "machine" // -// "github.com/tinygo-org/drivers/bmp180" +// "tinygo.org/x/drivers/bmp180" // ) // // func main() { diff --git a/easystepper/easystepper.go b/easystepper/easystepper.go index f70c83a..521eb95 100644 --- a/easystepper/easystepper.go +++ b/easystepper/easystepper.go @@ -1,4 +1,4 @@ -// Simple driver to rotate a 4-wire stepper motor +// Package easystepper provides a simple driver to rotate a 4-wire stepper motor. package easystepper // import "tinygo.org/x/drivers/easystepper" import ( diff --git a/espat/mqtt/mqtt.go b/espat/mqtt/mqtt.go index 95cab72..57bda0b 100644 --- a/espat/mqtt/mqtt.go +++ b/espat/mqtt/mqtt.go @@ -1,3 +1,5 @@ +// Package mqtt is intended to provide compatible interfaces with the +// Paho mqtt library. package mqtt import (