drill-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ted Dunning" <tdunn...@apache.org>
Subject Re: Review Request 29278: Drill-1904 package level docs
Date Fri, 16 Jan 2015 23:23:54 GMT

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



common/src/main/java/org/apache/drill/common/config/package-info.java
<https://reviews.apache.org/r/29278/#comment112768>

    Is nesting the salient character for this package?  Is there anything else that would
be surprising?



common/src/main/java/org/apache/drill/common/exceptions/package-info.java
<https://reviews.apache.org/r/29278/#comment112770>

    Probably not even needed.  The name and the content speak for themselves.
    
    They may be something that is not said by these contents, but the mere fact that these
are exceptions is, so to say, unexceptional.



common/src/main/java/org/apache/drill/common/expression/package-info.java
<https://reviews.apache.org/r/29278/#comment112771>

    Too thin to say anything here.  What is a logical expression?  An expression with nothing
but booleans?  Or an expression in the logical plan.
    
    Perhaps clarification by amplification is in order.



common/src/main/java/org/apache/drill/common/expression/visitors/package-info.java
<https://reviews.apache.org/r/29278/#comment112772>

    Used in what context?  Who calls these? When are the inserted?



common/src/main/java/org/apache/drill/common/logical/FormatPluginConfig.java
<https://reviews.apache.org/r/29278/#comment112773>

    Suggest "Formats are file formats that have nothing to do with how the file is stored,
such as CSV or protobuf.



common/src/main/java/org/apache/drill/common/logical/FormatPluginConfigBase.java
<https://reviews.apache.org/r/29278/#comment112776>

    A tiny bit more would be nice.  "To use this base class, sub-class it and define ....
 Watch out fo r ..."



exec/java-exec/src/main/java/org/apache/drill/exec/coord/package-info.java
<https://reviews.apache.org/r/29278/#comment112785>

    Need a bit more here.  Could have a pointer to what sort of coordination is done and a
description of why.
    
    Is Curator used?



exec/java-exec/src/main/java/org/apache/drill/exec/package-info.java
<https://reviews.apache.org/r/29278/#comment112780>

    This is a top-level description that should not quote so much as redirect the reader.
 A link to the architecture home page is sufficient for that.  Links to the key pieces of
code to read next would be very helpful as well.


- Ted Dunning


On Jan. 15, 2015, 10:16 p.m., Jason Altekruse wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/29278/
> -----------------------------------------------------------
> 
> (Updated Jan. 15, 2015, 10:16 p.m.)
> 
> 
> Review request for drill, Daniel Barclay and Jacques Nadeau.
> 
> 
> Bugs: Drill-1904
>     https://issues.apache.org/jira/browse/Drill-1904
> 
> 
> Repository: drill-git
> 
> 
> Description
> -------
> 
> Add package level documentation to the sources of Drill
> 
> 
> Diffs
> -----
> 
>   common/src/main/java/org/apache/drill/common/config/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/exceptions/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/expression/aggregate/BasicAggregates.java
5f18aaf 
>   common/src/main/java/org/apache/drill/common/expression/fn/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/expression/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/expression/types/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/expression/visitors/package-info.java
PRE-CREATION 
>   common/src/main/java/org/apache/drill/common/graph/package-info.java PRE-CREATION 
>   common/src/main/java/org/apache/drill/common/logical/FormatPluginConfig.java 936e4f2

>   common/src/main/java/org/apache/drill/common/logical/FormatPluginConfigBase.java 0704085

>   common/src/main/java/org/apache/drill/common/logical/data/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/logical/data/visitors/package-info.java
PRE-CREATION 
>   common/src/main/java/org/apache/drill/common/logical/package-info.java PRE-CREATION

>   common/src/main/java/org/apache/drill/common/package-info.java PRE-CREATION 
>   common/src/main/java/org/apache/drill/common/types/package-info.java PRE-CREATION 
>   common/src/main/java/org/apache/drill/common/util/package-info.java PRE-CREATION 
>   contrib/storage-mongo/src/main/java/org/apache/drill/exec/store/mongo/package-info.java
PRE-CREATION 
>   exec/java-exec/src/main/java/org/apache/drill/exec/cache/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/client/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/compile/bytecode/package-info.java
PRE-CREATION 
>   exec/java-exec/src/main/java/org/apache/drill/exec/compile/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/compile/sig/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/coord/local/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/coord/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/coord/zk/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/disk/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/dotdrill/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/exception/package-info.java PRE-CREATION

>   exec/java-exec/src/main/java/org/apache/drill/exec/package-info.java PRE-CREATION 
> 
> Diff: https://reviews.apache.org/r/29278/diff/
> 
> 
> Testing
> -------
> 
> Just comments, no code changes
> 
> 
> Thanks,
> 
> Jason Altekruse
> 
>


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