From 36c7f3a536f0fea631d8c34878b1fd6dda68db1e Mon Sep 17 00:00:00 2001
From: Karan Misra <kidoman@gmail.com>
Date: Mon, 6 Jan 2014 02:34:19 +0530
Subject: [PATCH] add doc

---
 util/map.go | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/util/map.go b/util/map.go
index a60f999..27acc0e 100644
--- a/util/map.go
+++ b/util/map.go
@@ -1,5 +1,12 @@
+// Package util contains utility functions.
 package util
 
+// Map re-maps a number from one range to another.
+//
+// Example:
+//
+//	val := Map(angle, 0, 180, 1000, 2000)
+//
 func Map(x, inmin, inmax, outmin, outmax int64) int64 {
 	return (x-inmin)*(outmax-outmin)/(inmax-inmin) + outmin
 }