mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Till Toenshoff <toensh...@me.com>
Subject Re: Review Request 53384: Cleaned up formatting in release-guide.md according to our guidelines.
Date Thu, 03 Nov 2016 21:28:03 GMT


> On Nov. 3, 2016, 8:40 p.m., Vinod Kone wrote:
> > docs/release-guide.md, lines 14-16
> > <https://reviews.apache.org/r/53384/diff/4/?file=1553128#file1553128line14>
> >
> >     If you want to make the list unordered you should use "*". Seems weird to use
`1` here.
> 
> Alexander Rukletsov wrote:
>     It's autonumeration : )

Would we break the rendering if we used proper enumerations? My thoughts here:

- I am reading markdown in its source often enough (instead of rendered versions)
- If I do so, others likely do as well
- Using autonumerations reduces the risk of mistakes in edits
- The effect of mistakes would reduce usability
- Using autonumerations instead of explicit enumerations reduces usability for me
==
Using autonumerations reduces usability while also lowering the risk of reduced usability
Using enumerations has the risk of reduced usability
==
Enumerations please!


- Till


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


On Nov. 3, 2016, 9:27 p.m., Alexander Rukletsov wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/53384/
> -----------------------------------------------------------
> 
> (Updated Nov. 3, 2016, 9:27 p.m.)
> 
> 
> Review request for mesos, Joris Van Remoortere and Till Toenshoff.
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> This change includes:
> * Automatic enumeration of lists.
> * Title case capitalization.
> * Correct spacing between sections.
> * Correct indentation of text and code snippets.
> * Correct decoration of notes and code snippets.
> * Wrapped text for readability and diff-ability.
> 
> 
> Diffs
> -----
> 
>   docs/release-guide.md cc859930ebce45a3d7902d783e7ef36f1f2522c8 
> 
> Diff: https://reviews.apache.org/r/53384/diff/
> 
> 
> Testing
> -------
> 
> Rendered the doc in MacDown.
> GitHub render: https://gist.github.com/rukletsov/bd9c1069dc285f9000c4419210603cb7
> 
> 
> Thanks,
> 
> Alexander Rukletsov
> 
>


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