mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joseph Wu <jos...@mesosphere.io>
Subject Re: Review Request 42939: Synchronized 'configuration.md' with the 'flags.cpp' files.
Date Fri, 29 Jan 2016 17:56:07 GMT

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



A couple of fixes you can make to the help strings and then auto-generate to this review:


docs/configuration.md (line 50)
<https://reviews.apache.org/r/42939/#comment178044>

    Consider surrounding all these flags with `<code>` blocks.



docs/configuration.md (line 263)
<https://reviews.apache.org/r/42939/#comment178039>

    Remove the extra "Defaults to..."?



docs/configuration.md (lines 277 - 278)
<https://reviews.apache.org/r/42939/#comment178038>

    Do you want to add a `<p/>` here (as an automatic replacement for "\n\n")?  The
space here has no effect on the rendered text; and the resulting paragraph is somewhat harder
to read.



docs/configuration.md (line 280)
<https://reviews.apache.org/r/42939/#comment178040>

    Remove extra default?



docs/configuration.md (line 325)
<https://reviews.apache.org/r/42939/#comment178041>

    Do you want to retain the spacing and the boldness?



docs/configuration.md (lines 344 - 346)
<https://reviews.apache.org/r/42939/#comment178043>

    Does this render correctly for you?  Adjacent `<code>` blocks are rendered inline.


- Joseph Wu


On Jan. 29, 2016, 9:41 a.m., Greg Mann wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/42939/
> -----------------------------------------------------------
> 
> (Updated Jan. 29, 2016, 9:41 a.m.)
> 
> 
> Review request for mesos and Vinod Kone.
> 
> 
> Bugs: MESOS-4298
>     https://issues.apache.org/jira/browse/MESOS-4298
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Synchronized 'configuration.md' with the 'flags.cpp' files.
> 
> Programatically generated HTML from the flag help strings and imported that text into
'configuration.md', thus synchronizing the documentation with the source code.
> 
> 
> Diffs
> -----
> 
>   docs/configuration.md b1ef1314eb9482a55015baa42b51d59b9f464a29 
> 
> Diff: https://reviews.apache.org/r/42939/diff/
> 
> 
> Testing
> -------
> 
> Viewed with the mesos website container: https://github.com/mesosphere/mesos-website-container
> 
> 
> Thanks,
> 
> Greg Mann
> 
>


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