[
https://issues.apache.org/jira/browse/CB-10330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15110988#comment-15110988
]
ASF GitHub Bot commented on CB-10330:
-------------------------------------
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/460#issuecomment-173651559
This looks great! Couple of comments - while your example illustrates this
- your specification is not very precise:
1. Consider clarifying the position of 'Required', 'Default' in the
description. Also, consider structure the details e.g. Description should
include the following in order:
- Default: Use *italics* formatting to provide default value of the
attribute
- Required: Use *italics* formatting to provide whether the attribute is
required. I would imagine if a value is not required - there would be a default
value.
- Platforms supported: Use **bold** to specify platforms supported. Default
is supported in all platforms.
2. Consider making the platform supported part of the description instead
of the name. You can still use bold.
> Define a standard way to document references in the new IA
> ----------------------------------------------------------
>
> Key: CB-10330
> URL: https://issues.apache.org/jira/browse/CB-10330
> Project: Apache Cordova
> Issue Type: Task
> Components: Docs
> Reporter: Raghav
> Assignee: Raghav
> Labels: Docs-6.x
>
> We have a new section for references in the new IA which will have the
> following articles:
> Config.xml
> Events
> Plugin APIs
> CLI
> Hooks
> Plugin.xml
> We need to define a uniform standard for these to follow. Some of these are
> API references, some XML.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
