Re: Backticks in comments

2015-11-16 Thread Greg Mann
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 wrote: > Thanks for the input y'all, sounds like we have a general consensus for > backticks in comments to enclose c

Re: Backticks in comments

2015-11-06 Thread Greg Mann
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 wrote: > +1

Re: Backticks in comments

2015-11-06 Thread Alexander Rojas
+1 for backticks! > On 02 Nov 2015, at 19:32, Greg Mann 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 does

Re: Backticks in comments

2015-11-06 Thread Adam Bordelon
+1 Make it so. On Wed, Nov 4, 2015 at 7:31 AM, haosdent wrote: > +1 Backticks used in markdown widely. > > On Wed, Nov 4, 2015 at 11:03 PM, Bernd Mathiske > wrote: > > > +1 > > > > > On Nov 2, 2015, at 8:34 PM, Isabel Jimenez < > > contact.isabeljime...@gmail.com> wrote: > > > > > > +1 for back

Re: Backticks in comments

2015-11-04 Thread haosdent
+1 Backticks used in markdown widely. On Wed, Nov 4, 2015 at 11:03 PM, Bernd Mathiske wrote: > +1 > > > On Nov 2, 2015, at 8:34 PM, Isabel Jimenez < > contact.isabeljime...@gmail.com> wrote: > > > > +1 for backticks, same comment as Kapil, really nice to be able to make a > > difference from str

Re: Backticks in comments

2015-11-04 Thread Bernd Mathiske
+1 > On Nov 2, 2015, at 8:34 PM, Isabel Jimenez > wrote: > > +1 for backticks, same comment as Kapil, really nice to be able to make a > difference from string literals. > > On Mon, Nov 2, 2015 at 11:26 AM, Kapil Arya wrote: > >> +1 for backticks. Also allows us to differentiate ordinary str

Re: Backticks in comments

2015-11-02 Thread Isabel Jimenez
+1 for backticks, same comment as Kapil, really nice to be able to make a difference from string literals. On Mon, Nov 2, 2015 at 11:26 AM, Kapil Arya wrote: > +1 for backticks. Also allows us to differentiate ordinary string literals > like names, etc., from code. > > On Mon, Nov 2, 2015 at 2:1

Re: Backticks in comments

2015-11-02 Thread Kapil Arya
+1 for backticks. Also allows us to differentiate ordinary string literals like names, etc., from code. On Mon, Nov 2, 2015 at 2:18 PM, Marco Massenzio wrote: > +1 > > I much favor using backticks everywhere for consistency, since (as you > correctly pointed out) our Doxygen style requires that.

Re: Backticks in comments

2015-11-02 Thread Marco Massenzio
+1 I much favor using backticks everywhere for consistency, since (as you correctly pointed out) our Doxygen style requires that. Hopefully, over time, we will have the whole codebase consistent again (also an invite to folks, if you touch the code, to update comments accordingly). BTW - unfortun

Re: Backticks in comments

2015-11-02 Thread Alex Clemmer
+1. Additional note is that this is now the de facto syntax for code snippets on the rest of our tools, too, including RB and JIRA. On Mon, Nov 2, 2015 at 10:32 AM, Greg Mann wrote: > Hey folks! > I wanted to bring up a style issue that I noticed recently. In some > comments in the codebase, back

Backticks in comments

2015-11-02 Thread Greg Mann
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