Merge #154121

154121: rangefeed: fix mangled comment r=wenyihu6 a=stevendanna

This comment went through a few revisions and I mangle it when rebasing.

Epic: none
Release note: None

Co-authored-by: Steven Danna <[email protected]>

Author: craig[bot]

pkg/kv/kvserver/rangefeed/buffered_sender.go

@@ -50,21 +50,23 @@ import (
 
 // RangefeedSingleBufferedSenderQueueMaxSize is the maximum number of events
 // that the buffered sender will buffer before it starts returning capacity
-// exceeded errors. Updates to this setting are only applied to need
-// MuxRangefeedCalls, existing streams will use the previous value until
+// exceeded errors. Updates to this setting are only applied to new
+// MuxRangefeedCalls. Existing streams will use the previous value until
 // restarted.
 //
-// # The main goal of this limit is to provide a backstop against the
-//
-// The default here has been somewhat arbitrarily chosen considering that:
+// The default here has been arbitrarily chosen. Ideally,
 //
 //   - We want to avoid capacity exceeded errors that wouldn't have occurred
 //     when the buffered registrations were in use.
 //
 //   - We don't want to drastically increase the amount of queueing allowed for a
 //     single registration.
 //
-//   - One buffered sender is feeding a single gRPC client.
+// A small buffer may be justified given that:
+//
+//   - One buffered sender is feeding a single gRPC client, so scaling based on
+//     registrations doesn't necessarily make sense. If the consumer is behind, it
+//     is behind.
 //
 //   - Events emitted during catchup scans have their own per-registration buffer
 //     still.