[
https://issues.apache.org/jira/browse/CB-4663?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Bas Bosman updated CB-4663:
---------------------------
Component/s: Plugin File
> File API documentation - FileWriter headings are incorrect
> ----------------------------------------------------------
>
> Key: CB-4663
> URL: https://issues.apache.org/jira/browse/CB-4663
> Project: Apache Cordova
> Issue Type: Bug
> Components: Docs, Plugin File
> Affects Versions: 2.9.0
> Reporter: Peter
> Assignee: Michael Brooks
> Priority: Minor
>
> Many the headings in the *FileWriter* section are incorrect and/or
> inconsistent with other sections making it difficult to read
> For example,
> * "Seek Quick Example" - this is a function name. Heading should be "seek"
> * "Quick Example" - should be h3 instead of h2
> * "Truncate Quick Example" - this is a function name. Heading should be
> "truncate"
> * "Quick Example" - should be h3 instead of h2
> * "Write Quick Example" - this is a function name. Heading should just be
> "write"
> * "Write Quick Example - should be h3 instead of h2 and called something like
> "Text Write Quick Example" (under the "write" section)
> * "Binary Write Quick Example" - should be h3 instead of h2 (still under
> "write" section)
> * "Append Quick Example" - should be h3 instead of h2 (still under "write"
> section)
> * "Abort Quick Example" - this is a function name. Heading should be "abort"
> (would also be better to be alphabetical order - ie above "seek" section)
> * "Quick Example" - should be h3 instead of h2
> Ref:
> http://cordova.apache.org/docs/en/3.0.0/cordova_file_file.md.html#FileWriter
> (similar to CB-4644)
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
