mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ben Mahler <benjamin.mah...@gmail.com>
Subject Re: Review Request 43220: Added script to generate docs from endpoint help strings.
Date Fri, 05 Feb 2016 05:17:25 GMT

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



Awesome!


support/generate-endpoint-help.py (lines 39 - 40)
<https://reviews.apache.org/r/43220/#comment179265>

    Hm.. could we make the key, value types a bit more explicit here?



support/generate-endpoint-help.py (lines 42 - 43)
<https://reviews.apache.org/r/43220/#comment179266>

    Wonder if this will tell the user nicely that this needs to be run within the git repo.



support/generate-endpoint-help.py (lines 53 - 75)
<https://reviews.apache.org/r/43220/#comment179267>

    Maybe some newlines here?



support/generate-endpoint-help.py (lines 64 - 75)
<https://reviews.apache.org/r/43220/#comment179268>

    I wonder if we want to let users set flags, is the intention that there may be some help
information that requires different flag values? If that were the case, almost seems as though
this script should be smart enough to know which incantantions to run to produce all of the
necessary help files.



support/generate-endpoint-help.py (lines 85 - 143)
<https://reviews.apache.org/r/43220/#comment179269>

    Hm.. can we avoid all the `_or_die` wrappers and just let the exceptions throw?



support/generate-endpoint-help.py (lines 189 - 197)
<https://reviews.apache.org/r/43220/#comment179270>

    Should this loop until a duration elapses? (printing the error if it can't pass after
duration elapses would be nice)
    
    Might also want a small sleep between each iteration?



support/generate-endpoint-help.py (lines 206 - 208)
<https://reviews.apache.org/r/43220/#comment179271>

    Is this how we do constants in the python helpers? Or do we use CAPS and variables instead
of functions?



support/generate-endpoint-help.py (lines 221 - 227)
<https://reviews.apache.org/r/43220/#comment179272>

    Might be nice to show an example transformation?



support/generate-endpoint-help.py (lines 225 - 227)
<https://reviews.apache.org/r/43220/#comment179273>

    Do you need the empty check? Also I think we've been doing `if new_name` in our python
style.



support/generate-endpoint-help.py (line 230)
<https://reviews.apache.org/r/43220/#comment179275>

    Maybe top_dir?



support/generate-endpoint-help.py (lines 230 - 241)
<https://reviews.apache.org/r/43220/#comment179276>

    Maybe an example transformation would help?



support/generate-endpoint-help.py (line 244)
<https://reviews.apache.org/r/43220/#comment179278>

    Should it be turned into json much earlier in the program? I assume we don't need to manipulate
the raw string?



support/generate-endpoint-help.py (line 253)
<https://reviews.apache.org/r/43220/#comment179279>

    generate_index made me think it was the entire index and I didn't initially realize that
this was a subsection. Perhaps something like generate_links?
    
    Should topdir be something like prefix? Or prefix_path, prefix_dir?



support/generate-endpoint-help.py (lines 269 - 308)
<https://reviews.apache.org/r/43220/#comment179280>

    Maybe this could be one single string with percent parameters for the different sections
that will be filled in?



support/generate-endpoint-help.py (line 339)
<https://reviews.apache.org/r/43220/#comment179281>

    /health is generally what we recommend for checking "liveness"



support/generate-endpoint-help.py (line 352)
<https://reviews.apache.org/r/43220/#comment179282>

    /health is generally what we recommend for checking "liveness"



support/generate-endpoint-help.py (lines 356 - 363)
<https://reviews.apache.org/r/43220/#comment179283>

    Do we need these?



support/generate-endpoint-help.py (lines 366 - 383)
<https://reviews.apache.org/r/43220/#comment179284>

    I wonder if we need these? Sounds like master and agent should be parameters rather than
different function names?


- Ben Mahler


On Feb. 5, 2016, 3:30 a.m., Kevin Klues wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/43220/
> -----------------------------------------------------------
> 
> (Updated Feb. 5, 2016, 3:30 a.m.)
> 
> 
> Review request for mesos, Ben Mahler, Greg Mann, and Neil Conway.
> 
> 
> Bugs: MESOS-3831
>     https://issues.apache.org/jira/browse/MESOS-3831
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Invoke this script from anywhere within the mesos source tree
> (including in the build directory) to autogenerate documentation for
> all endpoint strings and install them into the docs/endpoint folder.
> In a subsequent commit we commit all of these autogenerated files back
> to the source repo and add a link in home.md to find them.
> 
> 
> Diffs
> -----
> 
>   support/generate-endpoint-help.py PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/43220/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Kevin Klues
> 
>


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