Fix erroneous acks xmldoc

jet · Dec 11, 2020 · d581594 · d581594
1 parent 9719c66
commit d581594
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 14 deletions.
diff --git a/src/FsKafka/FsKafka.fs b/src/FsKafka/FsKafka.fs
@@ -45,9 +45,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
 
  /// Creates and wraps a Confluent.Kafka ProducerConfig with the specified settings
  static member Create
- ( clientId : string, bootstrapServers : string,
- /// Default: All
- acks,
+ ( clientId : string, bootstrapServers : string, acks,
  /// Defines combination of linger/maxInFlight settings to effect desired batching semantics
  batching : Batching,
  /// Message compression. Default: None.
@@ -58,7 +56,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
  ?retryBackoff,
  /// Statistics Interval. Default: no stats.
  ?statisticsInterval,
- /// Ack timeout (assuming Acks != Acks.0). Confluent.Kafka default: 5s.
+ /// Ack timeout (assuming Acks != Acks.Zero). Confluent.Kafka default: 5s.
  ?requestTimeout,
  /// Confluent.Kafka default: false. Defaults to true.
  ?socketKeepAlive,
@@ -97,9 +95,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
  [<Obsolete "linger is now mandatory as a result of Confluent.Kafka 1.5's changing the default from 0.5ms to 5ms">]
  // TODO remove in 2.0.0
  static member Create
- ( clientId : string, bootstrapServers : string,
- /// Default: All
- acks,
+ ( clientId : string, bootstrapServers : string, acks,
  /// Message compression. Default: None.
  ?compression,
  /// Maximum in-flight requests. Default: 1_000_000.

diff --git a/src/FsKafka0/FsKafka.fs b/src/FsKafka0/FsKafka.fs
@@ -45,9 +45,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
 
  /// Creates and wraps a Confluent.Kafka ProducerConfig with the specified settings
  static member Create
- ( clientId : string, bootstrapServers : string,
- /// Default: All
- acks,
+ ( clientId : string, bootstrapServers : string, acks,
  /// Defines combination of linger/maxInFlight settings to effect desired batching semantics
  batching : Batching,
  /// Message compression. Default: None.
@@ -97,9 +95,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
  [<Obsolete "linger is now mandatory as a result of Confluent.Kafka 1.5's changing the default from 0.5ms to 5ms">]
  // TODO remove in 2.0.0
  static member Create
- ( clientId : string, bootstrapServers : string,
- /// Default: All
- acks,
+ ( clientId : string, bootstrapServers : string, acks,
  /// Message compression. Default: None.
  ?compression,
  /// Maximum in-flight requests. Default: 1_000_000.
@@ -114,7 +110,7 @@ type KafkaProducerConfig private (inner, bootstrapServers : string) =
  ?retryBackoff,
  /// Statistics Interval. Default: no stats.
  ?statisticsInterval,
- /// Ack timeout (assuming Acks != Acks.0). Confluent.Kafka default: 5s.
+ /// Ack timeout (assuming Acks != Acks.Zero). Confluent.Kafka default: 5s.
  ?requestTimeout,
  /// Confluent.Kafka default: false. Defaults to true.
  ?socketKeepAlive,