Review Board 1.7.22


Documentation improvements: API docs, part 2

Review Request #4921 - Created April 28, 2012 and updated

Alan Gates
HCATALOG-381
Reviewers
hcatalog
hcatalog
Javadoc improvements

 
Posted (April 28, 2012, 12:32 a.m.)
There are quite a few spacing issues, like maybe you're mixing tabs and spaces or something.  The policy in HCat code is to use only spaces.
  1. In HCATALOG-424.patch, Sushanth replaced all the tabs and standardized the spacing and line breaks.
"at the indicated position in the record" would be better than "at a specified index"
  1. Done.
Should note that after this call will copy the pointers to the data, not the data itself.  Should also note that this call will obliterate anything currently in this record.
  1. Clarification, please.  What does "after this" mean, or is "after" a typo?  Does this wording work? -- 
    
    "Abstract method to copy an HCatRecord to the current HCatRecord.  This call copies the pointers to the data, not the data itself.  Note that this call will obliterate anything currently in this record."
What do the default values mean in this enum list?  These look like the defaults from Java.  But HCat/Hive doesn't have a notion of default values.  The ranges are nice, we should remove the default values.
  1. They were defaults from Java, indeed.  The replacement patch gets rid of them.
Spacing looks off here.
Spacing issue
Bunch of spacing issues
Bunch of spacing issues
Spacing issue
Spacing issue
spacing
spacing
spacing
Bunch of spacing issues
These comments don't look like they match with the function.
  1. Changed the description of writeExternal(ObjectOutput out) from "Save the ReaderContext contents" to "Write the input splits used by this reader to an external location."
These comments don't look like they match with the function.
  1. Changed the description of readExternal(ObjectInput in) from "Restore the ReaderContext contents" to "Read an external list of input splits to restore the contents of this ReaderContext."
Spacing
Spacing
Spacing
Spacing
Spacing
Should read "slave nodes for writing" rather than "the writer"
  1. Done.
spacing
spacing
These comments dont't seem to match this function.
  1. Changed the description of writeExternal(ObjectOutput out) from "Save the WriterContext contents" to "Write the configuration to an external location."
These comments don't seem to match this function.
  1. Changed the description of readExternal(ObjectInput in) from "Restore the WriterContext contents" to "Restore the contents of this WriterContext with data read from an external location."