Re: PIP 116: Create Pulsar Writing Style Guide

2021-12-15 Thread Yu Liu
Hi Haiting, There are no automatic tools to check **all** writing style issues, but they can help check some. Steps see https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0/edit Hi Dave, Thanks! I've incorporated your comments. On Thu, Dec 16, 2021 at 2:34 AM Dave Fish

Re: PIP 116: Create Pulsar Writing Style Guide

2021-12-15 Thread Dave Fisher
Thanks Yu for this initiative. I made a small correction in the document. Regards, Dave > On Dec 14, 2021, at 7:17 PM, Yu wrote: > > Hi Pulsar enthusiasts, > > > As you may notice, there are more and more documentation contributions > nowadays, which is great! > > > Similar to coding style

Re: PIP 116: Create Pulsar Writing Style Guide

2021-12-15 Thread Haiting Jiang
+1, Great stuff. I am wondering if there is some tool to check it automatically? like code-style check. Thanks, Haiting On 2021/12/15 03:17:45 Yu wrote: > Hi Pulsar enthusiasts, > > > As you may notice, there are more and more documentation contributions > nowadays, which is great! > > > Si

PIP 116: Create Pulsar Writing Style Guide

2021-12-14 Thread Yu
Hi Pulsar enthusiasts, As you may notice, there are more and more documentation contributions nowadays, which is great! Similar to coding style guides, in the field of technical writing, a writing style guide is a must to improve users' experience and eliminate writers' workload. To improve t