[ 
https://issues.apache.org/jira/browse/HADOOP-13708?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15569968#comment-15569968
 ] 

Andrew Wang commented on HADOOP-13708:
--------------------------------------

Great work here, thanks for sending us a patch. I have a couple small nits, 
some of which are not related to your changes but things I saw while looking at 
the diff.

Some things I think read better as the original:

* "Identifying the audience of an interface helps defining the impact of 
breaking" 
* "The interface is for general use by any applications."
* "implementing rolling upgrades. It communicates that this interface should"
* Prefer we leave the empty Precondition headers in the FileSystem specification
* "dest` will match those under `src`, as will the contents do:"

Suggestions:

* "e.g. In HDFS, FSImage stability can help providing more flexible roll 
backs." -> "provide more flexible rollback."
* "A good example of a limited-private interface is BlockLocations, This is" -> 
"A good example of a limited-private interface is BlockLocations. This is a"
* "have got a coordinated effort with the MR team to release matching releases" 
-> "coordinate release efforts with the MR team"
* "While the caller may expect for as much buffer as possible to be filled" -> 
"While the caller may expect as much of the buffer as possible to be filled"
* "be used as direct replacement for HDFS." -> "be used as direct replacements 
for HDFS."

> Fix a few typos in site *.md documents
> --------------------------------------
>
>                 Key: HADOOP-13708
>                 URL: https://issues.apache.org/jira/browse/HADOOP-13708
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 2.8.0
>            Reporter: Ding Fei
>            Assignee: Ding Fei
>            Priority: Minor
>         Attachments: HADOOP-13708.patch
>
>
> Fix several typos in site *.md documents. 
> Touched documents listed:
> * hadoop-tools/hadoop-archives/src/site/markdown/HadoopArchives.md.vm
> * hadoop-common-project/hadoop-common/src/site/markdown/filesystem/testing.md
> * 
> hadoop-common-project/hadoop-common/src/site/markdown/filesystem/fsdatainputstream.md
> * 
> hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md
> * hadoop-common-project/hadoop-common/src/site/markdown/filesystem/notation.md
> * 
> hadoop-common-project/hadoop-common/src/site/markdown/filesystem/introduction.md
> * hadoop-common-project/hadoop-common/src/site/markdown/filesystem/model.md
> * 
> hadoop-common-project/hadoop-common/src/site/markdown/InterfaceClassification.md
> * hadoop-common-project/hadoop-common/src/site/markdown/ClusterSetup.md
> * hadoop-common-project/hadoop-common/src/site/markdown/Compatibility.md



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org

Reply via email to