From 5c75423e3cd557d237a03c59e9e44483ca9112af Mon Sep 17 00:00:00 2001
From: Antonio Salazar Cardozo <antonio@keep.network>
Date: Fri, 4 May 2018 11:09:32 -0400
Subject: [PATCH] common/compiler: Add docs to compiler.Contract and
 compiler.ContractInfo

---
 common/compiler/solidity.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/common/compiler/solidity.go b/common/compiler/solidity.go
index 234714a2b9..74e1b65003 100644
--- a/common/compiler/solidity.go
+++ b/common/compiler/solidity.go
@@ -31,11 +31,17 @@ import (
 
 var versionRegexp = regexp.MustCompile(`([0-9]+)\.([0-9]+)\.([0-9]+)`)
 
+// Contract contains information about a compiled contract, alongside its code.
 type Contract struct {
 	Code string       `json:"code"`
 	Info ContractInfo `json:"info"`
 }
 
+// ContractInfo contains information about a compiled contract, including access
+// to the ABI definition, user and developer docs, and metadata.
+//
+// Depending on the source, language version, compiler version, and compiler
+// options will provide information about how the contract was compiled.
 type ContractInfo struct {
 	Source          string      `json:"source"`
 	Language        string      `json:"language"`