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.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org
For additional commands, e-mail: dev-h...@cordova.apache.org
