Browse Source

Fix package documentation

Evan Huus 12 năm trước cách đây
mục cha
commit
3830264319
2 tập tin đã thay đổi với 4 bổ sung6 xóa
  1. 0 5
      client.go
  2. 4 1
      sarama.go

+ 0 - 5
client.go

@@ -1,8 +1,3 @@
-/*
-Package kafka provides a high-level API for writing Kafka clients.
-
-It is built on sister package sarama/protocol.
-*/
 package kafka
 
 import (

+ 4 - 1
sarama.go

@@ -1,4 +1,7 @@
 /*
-Package kafka provides client libraries for the Kafka 0.8 protocol.
+Package kafka provides client libraries for the Kafka 0.8 protocol. The Client, Producer and Consumer objects are the core of the high-level API. The Broker and Request/Response objects permit more precise control.
+
+The Request/Response objects and properties 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 kafka