You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@mesos.apache.org by Joerg Schad <jo...@mesosphere.io> on 2015/11/17 09:07:09 UTC
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/
-----------------------------------------------------------
(Updated Nov. 17, 2015, 8:07 a.m.)
Review request for mesos and Bernd Mathiske.
Repository: mesos
Description
-------
Added style guideline for writing numbers to markdown styleguide.
Diffs
-----
docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
Diff: https://reviews.apache.org/r/40292/diff/
Testing
-------
viewed rendered version.
Thanks,
Joerg Schad
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Guangya Liu <gy...@gmail.com>.
> On 十一月 17, 2015, 8:16 a.m., Guangya Liu wrote:
> > docs/markdown-style-guide.md, line 116
> > <https://reviews.apache.org/r/40292/diff/1/?file=1125078#file1125078line116>
> >
> > s/10/ten?
> >
> > Another question is that can you please show an example from 10 upwards?
>
> Joerg Schad wrote:
> 10 should be 10 (and not ten), as numbers from 10 upward are figures. Therefore 10 is the first example for a number of 10 upward. Is the following be easier to understand: "We spell out numbers from zero to nine and use figures (i.e. digits) from 10 upwards."?
Thanks Joerg, the new proposal is much easier to understand. ;-)
- Guangya
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106807
-----------------------------------------------------------
On 十一月 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated 十一月 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Joerg Schad <jo...@mesosphere.io>.
> On Nov. 17, 2015, 8:16 a.m., Guangya Liu wrote:
> > docs/markdown-style-guide.md, line 116
> > <https://reviews.apache.org/r/40292/diff/1/?file=1125078#file1125078line116>
> >
> > s/10/ten?
> >
> > Another question is that can you please show an example from 10 upwards?
10 should be 10 (and not ten), as numbers from 10 upward are figures. Therefore 10 is the first example for a number of 10 upward. Is the following be easier to understand: "We spell out numbers from zero to nine and use figures (i.e. digits) from 10 upwards."?
- Joerg
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106807
-----------------------------------------------------------
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Guangya Liu <gy...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106807
-----------------------------------------------------------
docs/markdown-style-guide.md (line 116)
<https://reviews.apache.org/r/40292/#comment165597>
s/10/ten?
Another question is that can you please show an example from 10 upwards?
- Guangya Liu
On 十一月 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated 十一月 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Alexander Rukletsov <ru...@gmail.com>.
> On Nov. 17, 2015, 8:18 a.m., Alexander Rukletsov wrote:
> > What is the motivation for this? Are there any studies proving it facilitates preception?
>
> Joerg Schad wrote:
> Motivation is the current inconsistent writing of numbers e.g. in the c++ styleguide.
>
> Alexander Rukletsov wrote:
> Sorry for not being clear. My question is more "why do you propose such scheme?". For me it feels inconsistent to have both figures and spelled out numbers. My intuition is that such rule is harder to remember than simple ones like "use figures everywhere" or "always spell out". I assume you base your proposal on common practices in american? british? English or studies around human perception which are unknown to me as an ESL : ).
It looks like there are guideline on spelling out numbers versus using literals, though they are not consistent:
http://www.grammarbook.com/numbers/numbers.asp
http://www.dailywritingtips.com/10-rules-for-writing-numbers-and-numerals/
Another question I have, is your proposal related to docs only, or for code comments as well? Though I do think comments should be proper text, I'm not sure they should be fiction and would rather keep only numerals there.
- Alexander
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106809
-----------------------------------------------------------
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Joerg Schad <jo...@mesosphere.io>.
> On Nov. 17, 2015, 8:18 a.m., Alexander Rukletsov wrote:
> > What is the motivation for this? Are there any studies proving it facilitates preception?
>
> Joerg Schad wrote:
> Motivation is the current inconsistent writing of numbers e.g. in the c++ styleguide.
>
> Alexander Rukletsov wrote:
> Sorry for not being clear. My question is more "why do you propose such scheme?". For me it feels inconsistent to have both figures and spelled out numbers. My intuition is that such rule is harder to remember than simple ones like "use figures everywhere" or "always spell out". I assume you base your proposal on common practices in american? british? English or studies around human perception which are unknown to me as an ESL : ).
>
> Alexander Rukletsov wrote:
> It looks like there are guideline on spelling out numbers versus using literals, though they are not consistent:
> http://www.grammarbook.com/numbers/numbers.asp
> http://www.dailywritingtips.com/10-rules-for-writing-numbers-and-numerals/
>
> Another question I have, is your proposal related to docs only, or for code comments as well? Though I do think comments should be proper text, I'm not sure they should be fiction and would rather keep only numerals there.
This is in the markdown styleguide and hence only applies to documentation.
- Joerg
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106809
-----------------------------------------------------------
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Alexander Rukletsov <ru...@gmail.com>.
> On Nov. 17, 2015, 8:18 a.m., Alexander Rukletsov wrote:
> > What is the motivation for this? Are there any studies proving it facilitates preception?
>
> Joerg Schad wrote:
> Motivation is the current inconsistent writing of numbers e.g. in the c++ styleguide.
Sorry for not being clear. My question is more "why do you propose such scheme?". For me it feels inconsistent to have both figures and spelled out numbers. My intuition is that such rule is harder to remember than simple ones like "use figures everywhere" or "always spell out". I assume you base your proposal on common practices in american? british? English or studies around human perception which are unknown to me as an ESL : ).
- Alexander
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106809
-----------------------------------------------------------
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Joerg Schad <jo...@mesosphere.io>.
> On Nov. 17, 2015, 8:18 a.m., Alexander Rukletsov wrote:
> > What is the motivation for this? Are there any studies proving it facilitates preception?
Motivation is the current inconsistent writing of numbers e.g. in the c++ styleguide.
- Joerg
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106809
-----------------------------------------------------------
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Alexander Rukletsov <ru...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review106809
-----------------------------------------------------------
What is the motivation for this? Are there any studies proving it facilitates preception?
- Alexander Rukletsov
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Alexander Rojas <al...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review109488
-----------------------------------------------------------
-1 to this review. We are getting so many rules which regulate everything that instead of help its becomming a burden.
- Alexander Rojas
On Nov. 17, 2015, 9:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 9:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Bernd Mathiske <be...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review107198
-----------------------------------------------------------
Ship it!
Ship It!
- Bernd Mathiske
On Nov. 17, 2015, 12:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 12:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>
Re: Review Request 40292: Added style guideline for writing numbers to
markdown styleguide.
Posted by Greg Mann <gr...@mesosphere.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/40292/#review109545
-----------------------------------------------------------
-1
Personally, I have not yet encountered in a review the suggestion that I should change the style of numbering, so based on my own experience I'm not sure that including this in the style guide will save us any time in the review cycle? It's also not obvious to me that there is a real disadvantage to having inconsistency in our numbering styles.
- Greg Mann
On Nov. 17, 2015, 8:07 a.m., Joerg Schad wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/40292/
> -----------------------------------------------------------
>
> (Updated Nov. 17, 2015, 8:07 a.m.)
>
>
> Review request for mesos and Bernd Mathiske.
>
>
> Repository: mesos
>
>
> Description
> -------
>
> Added style guideline for writing numbers to markdown styleguide.
>
>
> Diffs
> -----
>
> docs/markdown-style-guide.md fe9ffefbbb2c0ce9ade39cec1de073163a9a03b2
>
> Diff: https://reviews.apache.org/r/40292/diff/
>
>
> Testing
> -------
>
> viewed rendered version.
>
>
> Thanks,
>
> Joerg Schad
>
>