The description does not need to be 100% the same in the code and docs.
Of course, we try to align them, but if they differ slightly it's ok, as
long as it's clear what they mean.
-Matthias
On 1/21/25 2:01 AM, Ukpa Uchechi wrote:
Hi Kafka Dev Community,
I’m currently working on updating the Kafka Streams documentation,
specifically the monitoring section. While reviewing the codebase, I
noticed that many of the descriptions are decoupled and defined in
different parts of the code, such as in statements like private static
final String DROPPED_RECORDS_TOTAL_DESCRIPTION = TOTAL_DESCRIPTION +
DROPPED_RECORDS_DESCRIPTION;.
Given this, should the descriptions in the codebase be followed exactly for
the documentation, or are they intended to serve as *guides* for rewording
and expanding upon in the docs? I want to make sure the descriptions are
clear, consistent, and helpful to users.
If I’m missing something in how to approach writing these descriptions, I’d
appreciate any clarification or guidance on the matter.
Thanks for your help!
Best regards,
Uchechi
