You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cordova.apache.org by "Michael Brooks (JIRA)" <ji...@apache.org> on 2013/08/22 08:40:52 UTC
[jira] [Commented] (CB-4644) File API documentation - FileReader
headings are incorrect
[ https://issues.apache.org/jira/browse/CB-4644?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13747299#comment-13747299 ]
Michael Brooks commented on CB-4644:
------------------------------------
Thanks for submitting all of these documentation issues, [~dinglemouse]. I really appreciate your attention to detail.
> File API documentation - FileReader headings are incorrect
> ----------------------------------------------------------
>
> Key: CB-4644
> URL: https://issues.apache.org/jira/browse/CB-4644
> Project: Apache Cordova
> Issue Type: Bug
> Components: Docs
> Affects Versions: 2.9.0
> Reporter: Peter
> Assignee: Michael Brooks
> Priority: Minor
>
> Many the headings in the *FileReader* section are incorrect and/or inconsistent with other sections making it difficult to read
> For example,
> * "Read As Data URL" - this is a function name. Heading should be "readAsDataURL"
> * Quick Example for readAsDataURL - should be h3 not h2
> * "Abort Quick Example" - should be h2 "abort" (because it is a function name)
> * This abort section seems misplaced - it is currently between the Quick and Full example for readAsText?
> * "Quick Example" should be h3.
> * "Read As Text" - this is a function name. Heading should be "readAsText"
> * Quick Example for readAsText - should be h3 not h2
> * Full Example for readAsText - should be h3 instead of h2
> * iOS Quirks for readAsText - should be h3 not h2
> * "Read As Binary String" - this is a function name. Heading should be "readAsBinaryString"
> * Quick Example for readAsBinaryString - should be h3 not h2
> * "Read As Array Buffer" - this is a function name. Heading should be "readAsArrayBuffer"
> * Quick Example for readAsArrayBuffer - should be h3 not h2
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira