Browse Source

Add a godoc note about the API stability exception for mock types.

Willem van Bergen 10 years ago
parent
commit
581b7a28eb
2 changed files with 6 additions and 0 deletions
  1. 3 0
      mocks/producer.go
  2. 3 0
      mocks/sync_producer.go

+ 3 - 0
mocks/producer.go

@@ -10,6 +10,9 @@ import (
 // Before you can send messages to it's Input channel, you have to set expectations
 // so it knows how to handle the input. This way you can easily test success and
 // failure scenarios.
+//
+// NOTE: the SyncProducer type currently does not fall under the API stability
+// guarantee of Sarama as it is stiull considered experimental.
 type Producer struct {
 	l            sync.Mutex
 	expectations []*producerExpectation

+ 3 - 0
mocks/sync_producer.go

@@ -9,6 +9,9 @@ import (
 // Before you can use it, you have to set expectations on the mock SyncProducer
 // to tell it how to handle calls to SendMessage, so you can easily test success
 // and failure scenarios.
+//
+// NOTE: the SyncProducer type currently does not fall under the API stability
+// guarantee of Sarama as it is stiull considered experimental.
 type SyncProducer struct {
 	l            sync.Mutex
 	t            ExpectationViolationReporter