MahsaSeifikar commented on PR #19141: URL: https://github.com/apache/kafka/pull/19141#issuecomment-2706719071
> LGTM > > https://github.com/apache/kafka/pull/19096/files#diff-439593088d083e21a92c1a0d89e4f299147740d123283a62cc7a303c2b5a7e0fL34 > > I noticed a previous PR and was curious about our docs' style. Are we leaning more towards sentences that start with **present tense** verbs and use imperative statements to guide users? It seems to be more consistent with our current documentation. When talking about changes, would something like "`FeatureX is/was removed` in the latest update" be cleaner than starting with "`Removed FeatureX.`"? What do you think? > > For reference: https://developers.google.com/style/tense [Microsoft Writing Style Guide/Verbs](https://learn.microsoft.com/en-us/style-guide/grammar/verbs) Thanks for pointing that out! I agree with you that we should use the present tense. In [this PR](https://github.com/apache/kafka/pull/19096/files#diff-439593088d083e21a92c1a0d89e4f299147740d123283a62cc7a303c2b5a7e0fL34), I found that sometimes we use the past tense and other times the present tense. I mistakenly assumed we should be using the past tense. I can open a PR to fix the previous one. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
