Mailing-List: contact dev-help@mesos.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@mesos.apache.org
Content-Type: multipart/alternative;
 boundary="===============7012147219560975025=="
MIME-Version: 1.0
Subject: Re: Review Request 32001: Required a period in trailing comments in
 the style guide.
From: "Ben Mahler" <benjamin.mahler@gmail.com>
To: "Ben Mahler" <benjamin.mahler@gmail.com>
Cc: "Niklas Nielsen" <nik@qni.dk>, "Michael Park" <mcypark@gmail.com>,
 "Timothy Chen" <tnachen@apache.org>,
 "Alexander Rukletsov" <rukletsov@gmail.com>, "mesos" <dev@mesos.apache.org>
Date: Mon, 06 Apr 2015 21:44:23 -0000
Message-ID: <20150406214423.18051.46483@reviews.apache.org>
Auto-Submitted: auto-generated
Sender: "Ben Mahler" <noreply@reviews.apache.org>
References: <20150312212035.1508.79940@reviews.apache.org>
In-Reply-To: <20150312212035.1508.79940@reviews.apache.org>
Reply-To: "Ben Mahler" <benjamin.mahler@gmail.com>

--===============7012147219560975025==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit


> On March 12, 2015, 9:20 p.m., Ben Mahler wrote:
> > docs/mesos-c++-style-guide.md, line 30
> > <https://reviews.apache.org/r/32001/diff/1/?file=892420#file892420line30>
> >
> >     Hm, isn't this captured by ending each sentence with a period above?
> 
> Alexander Rukletsov wrote:
>     Yes and no. Trailing comments are not always sentences (at least in my non-native speaker's language model), it can be for example a JIRA ticket. As an alternative we can re-phrase the statement above to something like "Each comment and sentences within it must end with a period." What do you think?
> 
> Michael Park wrote:
>     Haha I didn't even catch that: "End each __sentence__ with a period." Do we just mean "End each comment with a period."?
> 
> Alexander Rukletsov wrote:
>     Well, techically a comment may consist of multiple sentences, which means you can write something like this:
>     ```
>         // To compensate for the case where a non-strict registrar is
>         // being used, we explicitly deny removed slaves from
>         // re-registering
>         // This is because a non-strict registrar cannot
>         // enforce this
>         // We've already told frameworks the tasks were
>         // lost so it's important to deny the slave from re-registering.
>     ```
>     But maybe we lose too much time on this minor thing.
> 
> Niklas Nielsen wrote:
>     I would support mpark's idea here: How about having an extra bullet with "End each sentence with a period."?
> 
> Timothy Chen wrote:
>     To be technically correct, we need a end each sentence with some puncatuation, as you'll also commonly see this in our code:
>     
>     master_tests.cpp
>     // Step 7: Ensure the slave cannot re-register!
> 
> Niklas Nielsen wrote:
>     We got stuck here - BenM, would you prefer not to have the extra line? I think it is handy as we have seen the non-puncuation style bug quite a few times in comments.

Well, I'm still a bit surprised that this level of detail is necessary. If you guys think it's helpful, the first iteration of this diff seems more succinct to me :)


- Ben


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/32001/#review76286
-----------------------------------------------------------


On March 26, 2015, 1:08 p.m., Alexander Rukletsov wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/32001/
> -----------------------------------------------------------
> 
> (Updated March 26, 2015, 1:08 p.m.)
> 
> 
> Review request for mesos and Ben Mahler.
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> See summary.
> 
> 
> Diffs
> -----
> 
>   docs/mesos-c++-style-guide.md 439fe12ad137c1bed3a21d5a097c60a48f10a4f9 
> 
> Diff: https://reviews.apache.org/r/32001/diff/
> 
> 
> Testing
> -------
> 
> None (not a functional change).
> 
> 
> Thanks,
> 
> Alexander Rukletsov
> 
>


--===============7012147219560975025==--