docs: Make it clear that size constraints only apply for users
authorCheng Zhao <zcbenz@gmail.com>
Fri, 6 May 2016 05:21:19 +0000 (14:21 +0900)
committerCheng Zhao <zcbenz@gmail.com>
Fri, 6 May 2016 05:21:19 +0000 (14:21 +0900)
[ci skip]

docs/api/browser-window.md

index ea88220..895547c 100644 (file)
@@ -96,6 +96,11 @@ It creates a new `BrowserWindow` with native properties as set by the `options`.
   * `webPreferences` Object - Settings of web page's features. See more about
     this below.
 
+When setting minimum or maximum window size with `minWidth`/`maxWidth`/
+`minHeight`/`maxHeight`, it only constrains the users, it won't prevent you from
+passing a size that does not follow size constraints to `setBounds`/`setSize` or
+to the constructor of `BrowserWindow`.
+
 The possible values and behaviors of `type` option are platform dependent,
 supported values are: