mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Greg Mann <g...@mesosphere.io>
Subject Re: Review Request 65113: Added Developer Guide to documentation.
Date Tue, 16 Jan 2018 18:08:18 GMT

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



Thanks Andy, this is great! A few small comments below. Let's get this committed and then
myself and others can add onto it.


docs/developer-guide.md
Lines 33-34 (patched)
<https://reviews.apache.org/r/65113/#comment274634>

    Since this is contained in the preceding paragraph, this line can probably be removed?



docs/developer-guide.md
Lines 80-106 (patched)
<https://reviews.apache.org/r/65113/#comment274640>

    I think the "versus" between these examples makes the train of thought a bit hard to follow,
as if they are meant to contradict one another rather than both exhibit the same style.
    
    I might do:
    
    ```
    This matches POSIX-style programming, which is likely why this aproach was chosen.
    
    This POSIX-style code:
    
    <first_example>
    
    is similar to the following Mesos-style code:
    
    <second_example>
    ```



docs/developer-guide.md
Lines 143-144 (patched)
<https://reviews.apache.org/r/65113/#comment274644>

    I might recommend:
    
    "On Windows, the usual maximum path is about 255 characters (it varies per API)."



docs/developer-guide.md
Lines 170 (patched)
<https://reviews.apache.org/r/65113/#comment274643>

    Could you remove the extra whitespace characters here?



docs/developer-guide.md
Lines 186 (patched)
<https://reviews.apache.org/r/65113/#comment274650>

    s/and so/so/



docs/developer-guide.md
Lines 187-188 (patched)
<https://reviews.apache.org/r/65113/#comment274651>

    I would recommend:
    
    "the Windows APIs. Please double check against the documentation which value will indicate
that the handle is invalid."



docs/developer-guide.md
Lines 202 (patched)
<https://reviews.apache.org/r/65113/#comment274652>

    Is this the appropriate place for this line?


- Greg Mann


On Jan. 12, 2018, 2:06 a.m., Andrew Schwartzmeyer wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/65113/
> -----------------------------------------------------------
> 
> (Updated Jan. 12, 2018, 2:06 a.m.)
> 
> 
> Review request for mesos, Benjamin Mahler, Greg Mann, Jie Yu, and Joseph Wu.
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> This guide was started with the intent to capture "tribal knowledge"
> about Mesos development. I've added several general practices and
> patterns I've had explained to me by various Mesos developers, and also
> added a Windows section with design patterns I had documented
> externally.
> 
> 
> Diffs
> -----
> 
>   docs/advanced-contribution.md 6af24ccf32745dada7bb9b637a7ccd37b4769c72 
>   docs/developer-guide.md PRE-CREATION 
>   docs/home.md 4c1fb3738bc9cbb45e0bca65e0f5defaf8c33c0a 
> 
> 
> Diff: https://reviews.apache.org/r/65113/diff/1/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Andrew Schwartzmeyer
> 
>


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