From 49fd3ff41b64e388b8bd81db97b0af54f484a5dd Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Fri, 17 Jun 2016 12:33:50 -0700 Subject: [PATCH] document platform-specific arguments --- docs/styleguide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/styleguide.md b/docs/styleguide.md index c388b3184b01..b4d9150ae030 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -70,6 +70,14 @@ of argument is notated by either the common types: [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md). +If an argument is unique to certain platforms, those platforms are denoted +using a space-delimited italicized list following the datatype. Values can be +`OS X`, `Windows`, or `Linux`. + +``` +* `animate` Boolean (optional) _OS X_ _Windows_ +``` + ### Events An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event)