[
https://issues.apache.org/jira/browse/HADOOP-14398?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16112035#comment-16112035
]
Andrew Wang commented on HADOOP-14398:
--------------------------------------
Thanks for working on this Eddy, a few review comments:
h3. filesystem.md
bq. be invoked
should be "is invoked"
{quote}
* Files are overwritten by default, unless specify `builder.overwrite(false)`.
* Missing parent directories are not created by default, unless specify
`builder.recursive()`.
{quote}
I know the second is a behavior change compared to the current create APIs, is
the first too? We should call these out as differences if so.
h3. fsdataoutputstreambuilder.md
bq. being invoked.
Should be "is invoked"
* Should we also call out the change in default behavior compared to the
existing create call?
* The behavior of what {{opt}} and {{must}} do is not specified. What kind of
exception is thrown?
* Are there provisions for probing FS capabilities without {{must}} ?
* The example copy-pasted from the FSDataOutputStream builder class javadoc
looks realistic, but I don't think any of these are actually hooked up. I think
this make the example confusing. Would be better to use an fake "FooFileSystem"
or something in the example.
* Since this is a generic document, we might want to move the HDFS-specific
builder parameters to an HDFS-specific page. I'd normally suggest the class
javadoc, but for whatever reason they aren't published (they could be). Up to
you.
Overall I don't want to hold this up over things that can be improved later,
feel free to leave the harder stuff to follow-on work. Thanks again!
> Modify documents for the FileSystem Builder API
> -----------------------------------------------
>
> Key: HADOOP-14398
> URL: https://issues.apache.org/jira/browse/HADOOP-14398
> Project: Hadoop Common
> Issue Type: Sub-task
> Components: fs
> Affects Versions: 3.0.0-alpha3
> Reporter: Lei (Eddy) Xu
> Assignee: Lei (Eddy) Xu
> Labels: docuentation
> Attachments: HADOOP-14398.00.patch, HADOOP-14398.01.patch
>
>
> After finishes the API, we should update the document to describe the
> interface, capability and contract which the APIs hold.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org
