mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joerg Schad" <jo...@mesosphere.io>
Subject Re: Review Request 40292: Added style guideline for writing numbers to markdown styleguide.
Date Fri, 20 Nov 2015 18:39:07 GMT


> 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
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message