Browse Source

add link to kafka spec in main documentation

Evan Huus 12 years ago
parent
commit
251161d4f1
1 changed files with 3 additions and 0 deletions
  1. 3 0
      protocol/doc.go

+ 3 - 0
protocol/doc.go

@@ -19,5 +19,8 @@ specific type and return a Response of the appropriate type, for example:
 	// do things with response
 	// do things with response
 
 
 	broker.Close()
 	broker.Close()
+
+The objects and properties in this package are mostly undocumented, as they line up exactly with the
+protocol fields documented by Kafka at https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol
 */
 */
 package protocol
 package protocol