Move details next to params
authorKevin Sawicki <kevinsawicki@gmail.com>
Wed, 14 Dec 2016 18:19:38 +0000 (10:19 -0800)
committerKevin Sawicki <kevinsawicki@gmail.com>
Wed, 14 Dec 2016 18:19:38 +0000 (10:19 -0800)
docs/api/native-image.md

index 4ba3498..a1f6614 100644 (file)
@@ -141,15 +141,13 @@ console.log(image)
 
 * `buffer` [Buffer][buffer]
 * `options` Object (optional)
-  * `width` Integer (optional)
-  * `height` Integer (optional)
-  * `scaleFactor` Double (optional)
+  * `width` Integer (optional) - Required for bitmap buffers.
+  * `height` Integer (optional) - Required for bitmap buffers.
+  * `scaleFactor` Double (optional) - Defaults to 1.0.
 
 Returns `NativeImage`
 
-Creates a new `NativeImage` instance from `buffer`. The default `scaleFactor` is
-1.0. The `width` and `height` options are **required** and only used for bitmap
-buffers.
+Creates a new `NativeImage` instance from `buffer`.
 
 ### `nativeImage.createFromDataURL(dataURL)`