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

ASF GitHub Bot commented on HADOOP-18987:
-----------------------------------------

DieterDP-ng commented on code in PR #6292:
URL: https://github.com/apache/hadoop/pull/6292#discussion_r1475786033


##########
hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md:
##########
@@ -826,9 +826,9 @@ any successors.
 
 #### Postconditions
 
-    result = FSDataInputStream(0, FS.Files[p])
+    result = FSDataInputStream(0, FS'.Files[p])
 
-The result provides access to the byte array defined by `FS.Files[p]`; whether 
that
+The result provides access to the byte array defined by `FS'.Files[p]`; 
whether that

Review Comment:
   Aha, I then misinterpreted 
   
   > The suffix “’” (single quote) is used as the convention to indicate the 
state of the system after an operation
   
   on 
https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/filesystem/notation.html
   
   I'll add a small clarification there, and revert this.





> Corrections to Hadoop FileSystem API Definition
> -----------------------------------------------
>
>                 Key: HADOOP-18987
>                 URL: https://issues.apache.org/jira/browse/HADOOP-18987
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.3.6
>            Reporter: Dieter De Paepe
>            Assignee: Dieter De Paepe
>            Priority: Minor
>              Labels: pull-request-available
>
> I noticed a lot of inconsistencies, typos and informal statements in the 
> "formal" FileSystem API definition 
> ([https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/filesystem/index.html)]
> Creating this ticket to link my PR against.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to