aurora-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Chu-Carroll" <mchucarr...@twopensource.com>
Subject Re: Review Request 26688: Fix errors in help rendering:
Date Tue, 14 Oct 2014 17:00:32 GMT

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



src/test/python/apache/aurora/client/cli/test_help.py
<https://reviews.apache.org/r/26688/#comment96900>

    Yes, they are guaranteed to be unique. The argparse framework that this is built on checks
uniqueness, and raises an exception if there's any ambiguity.



src/test/python/apache/aurora/client/cli/test_help.py
<https://reviews.apache.org/r/26688/#comment96902>

    Anything can have an unset metavar, but most of the time, that isn't a problem. The default
metavar for an int is "int" - but in help strings, that works well.
    
    For example, you'll often see [--port=int]. That's good, and I don't think we want that
to be an error. Saying that the value is expected to be "int" is telling you something essential
about the value expected for the parameter.
    
    str is different, because it's the default type value for any structured input - pathnames,
config names, tunnel descriptors, instance lists, usernames, etc. Saying "str" doesn't tell
you anything meaningful about what's expected.


- Mark Chu-Carroll


On Oct. 14, 2014, 11:07 a.m., Mark Chu-Carroll wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/26688/
> -----------------------------------------------------------
> 
> (Updated Oct. 14, 2014, 11:07 a.m.)
> 
> 
> Review request for Aurora, David McLaughlin and Joshua Cohen.
> 
> 
> Bugs: aurora-831
>     https://issues.apache.org/jira/browse/aurora-831
> 
> 
> Repository: aurora
> 
> 
> Description
> -------
> 
> - Put plugin-generated options into the correct order.
> - Include the option-name in the detailed help list.
> - Add missing metavars.
> 
> 
> Diffs
> -----
> 
>   src/main/python/apache/aurora/client/cli/__init__.py da9d5b6ba4d22ba1f444341b97bbcfaf7889a4a8

>   src/main/python/apache/aurora/client/cli/options.py dc76c25b90acb9610e40b939e65c3cabf032649f

>   src/main/python/apache/aurora/client/cli/standalone_client.py 20f4d7ef43ba336a2b6d02cbf5656c97bdfa2ea1

>   src/test/python/apache/aurora/client/cli/test_help.py f73c8a3778b7d118ea2865f213b442a607fb4a7d

> 
> Diff: https://reviews.apache.org/r/26688/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Mark Chu-Carroll
> 
>


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