Hello everyone! FYI, here's the review for the backtick style guide change: https://reviews.apache.org/r/40367/
Greg On Fri, Nov 6, 2015 at 7:55 AM, Greg Mann <[email protected]> wrote: > Thanks for the input y'all, sounds like we have a general consensus for > backticks in comments to enclose code excerpts and object names. I'll > submit a patch to change the style guide and make it official. > > Cheers, > Greg > > On Fri, Nov 6, 2015 at 4:46 AM, Alexander Rojas <[email protected]> > wrote: > >> +1 for backticks! >> >> > On 02 Nov 2015, at 19:32, Greg Mann <[email protected]> wrote: >> > >> > Hey folks! >> > I wanted to bring up a style issue that I noticed recently. In some >> > comments in the codebase, backticks are used to quote code excerpts and >> > object names, while in other comments, single quotes are used. This >> doesn't >> > seem to be documented in our style guide (nor in Google's), and I think >> it >> > would be a good idea to establish a policy on this and document it, so >> that >> > we can avoid wasted review cycles related to this in the future. >> > >> > It's likely that the backtick convention began because Doxygen will >> render >> > backtick-enclosed text in monospace, and for this reason I would propose >> > that we consistently use backticks to quote code excerpts and object >> names >> > in comments from now on. What does everyone else think? >> > >> > Cheers, >> > Greg >> >> >
