hive-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Thejas Nair <the...@hortonworks.com>
Subject Re: Documenting API's for the 1.0.0 release
Date Tue, 13 Jan 2015 23:20:50 GMT
IMO, this would be javadocs. That should be the primary source of
truth for this information. We can additionally capture this in
wikidocs as well.



On Tue, Jan 13, 2015 at 3:08 PM, Lefty Leverenz <leftyleverenz@gmail.com> wrote:
> Thanks Brock.  Is this for javadocs or wikidocs, or both?
>
> -- Lefty
>
> On Tue, Jan 13, 2015 at 12:47 PM, Brock Noland <brock@cloudera.com> wrote:
>
>> Hi,
>>
>> As discussed at our last meetup, we should really document our public APIs.
>> Many had requested this be completed before Hive 1.0.0.
>>
>> As such I have created an uber jira to track this
>> https://issues.apache.org/jira/browse/HIVE-9362 and created two sample
>> sub-tasks for how I imagine this will play out.
>>
>> The most important task is documenting what we consider to be the public
>> API. Additionally even if the API is not public, our user community, e.g.
>> SparkSQL, Pig, etc, should document the API's they use. This way we'll at
>> least know who we are breaking when we make a change.
>>
>> Cheers,
>> Brock
>>

-- 
CONFIDENTIALITY NOTICE
NOTICE: This message is intended for the use of the individual or entity to 
which it is addressed and may contain information that is confidential, 
privileged and exempt from disclosure under applicable law. If the reader 
of this message is not the intended recipient, you are hereby notified that 
any printing, copying, dissemination, distribution, disclosure or 
forwarding of this communication is strictly prohibited. If you have 
received this communication in error, please contact the sender immediately 
and delete it from your system. Thank You.

Mime
View raw message