Commit Graph

59 Commits (roll-mantle)

Author SHA1 Message Date
David Sanders 3d2a754531
chore: extend linting of code blocks in the docs (#40245)
* chore: extend linting of code blocks in the docs

* chore: combine lint:markdownlint and lint:markdown scripts
2023-11-21 16:50:08 +09:00
Milan Burda e6b1d95a1c
docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
Jim Fisher 01b7ceac17
docs: coordinate system of badly named method getCursorScreenPoint (#27156)
* Document coordinate system of badly named method getCursorScreenPoint

[Electron inherits this confusing name from Chromium](99314be815/ui/display/win/screen_win.cc (L677-L681)). We can also see there that the return value is a DIPPoint, due to `ScreenToDIPPoint` call:

    gfx::Point ScreenWin::GetCursorScreenPoint() {
      POINT pt;
      ::GetCursorPos(&pt);
      return gfx::ToFlooredPoint(ScreenToDIPPoint(gfx::PointF(gfx::Point(pt))));
    }

I lost over a day due to debugging this. I don't think we can change the method name due to backwards compatibility, but we can at least make amends in the documentation.

* Remove advice

* Softer wording

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
2021-01-11 12:19:48 +09:00
Samuel Attard eb6616e4e9
build: update to standard 14 (#24479) 2020-07-09 10:18:49 -07:00
Charles Kerr c83f836faf
refactor: prefer using app.whenReady() (#21972)
* docs: add references to app.whenReady() in isReady

* refactor: prefer app.whenReady()

In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.

It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
Micha Hanselmann e59095423e docs: add exemplary fiddle for `launch in fiddle` feat (#19759)
* add fit-screen

* new url format

* nit
2019-08-15 15:37:37 -07:00
Shelley Vohr 3395a1d4db
doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
Shelley Vohr 7b55ee9d36 refactor: allow requiring modules with no side effects (#17496) 2019-04-30 09:46:08 +09:00
Milan Burda 713df08e3e chore: remove deprecated modules internally using remote.require in sandboxed renderer context (#15957) 2019-01-24 10:53:52 -08:00
Milan Burda d3efc52745 feat: add webPreferences.enableRemoteModule option (#13028) 2018-10-13 20:50:07 +03:00
Samuel Attard 558fff69e7
chore: update to standard 12 2018-09-14 14:57:01 +10:00
Milan Burda fceed0fcbc fix: dipToScreenRect / screenToDipRect - window can be null (#13903) 2018-08-03 13:08:42 +10:00
Shelley Vohr 72c63a10ee
remove screen.getMenuBarHeight() deprecation 2018-05-23 09:11:48 -07:00
Milan Burda 211d7825d3 feat: DIP <-> screen coordinate conversions (#12879) 2018-05-16 18:34:09 +09:00
Kevin Sawicki 653ef6f839 🎨 2017-06-05 10:33:46 -07:00
Shubham 793d5fd191 🎨 Fix documentation 2017-05-23 23:27:55 -04:00
Shubham ec0e33e258 Add mac_os tag to documentation 2017-05-23 22:39:54 -04:00
Shubham b2f1cdfbae Add API to get top bar height on macOS 2017-05-23 22:24:56 -04:00
Milan Burda 568454525d Use point / size / rectangle structures consistently in API docs 2017-04-04 08:31:09 +02:00
Zeke Sikelianos e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
mawie81 d20e2ec349 [ci skip] fix link in screen docs 2016-12-21 09:43:47 +01:00
Kevin Sawicki 6352afb07a Link to return class type 2016-12-19 09:40:07 -08:00
Zeke Sikelianos 471b9980ec line up process annotations consistently 2016-11-03 13:13:21 -07:00
Zeke Sikelianos ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Kevin Sawicki 65e6da2673 Add newlines before lists 2016-10-25 12:38:08 +09:00
Long Nhat Nguyen c017a7a1c7 Update url (#7598)
* Update EventEmitter URL

* Update EventEmitter URL

* Enable click

* Update EventEmitter URL

* Update EventEmitter URL

* Update URL

* Update URL

* Update EventEmitter URL

* Tweak sentence and add perios
2016-10-13 14:09:14 -07:00
Samuel Attard 4d49156dac
Rename bounds -> rectangle 2016-10-08 13:09:31 +11:00
Samuel Attard 03979936f3 Move reused object structures to a standard structures folder 2016-10-06 11:59:42 -07:00
Samuel Attard e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Samuel Attard d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Kevin Sawicki 0fda86f79a Mention not requiring module until app is ready 2016-09-16 11:42:02 -07:00
Zeke Sikelianos 06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Kushagra Sharma 61c0981ac7 remove extraneous 'not'
[ci skip]
2016-06-13 20:14:42 +05:30
Cheng Zhao 1a22caabe8 docs: Update the code sample of screen module
* We should not require it before the ready event;
* There is no need to use electronScreen as name in the main process.
2016-06-07 13:56:57 +09:00
Plusb Preco 5146befa46 📝 Match variable names
[ci skip]
2016-05-11 02:38:42 +09:00
Plusb Preco f1b184ef78 📝 Fix code style issue
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco 4d7296e1db 📝 Match destructuring style
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco 5787bb0226 📝 Fix code style issue
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.

[ci skip]
2016-05-10 18:42:21 +09:00
Steve Kinney 5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Cheng Zhao 096b948570 Merge pull request #5249 from electron/api-summaries
create a one-liner description for each API
2016-04-24 13:50:17 +09:00
Cheng Zhao 2f06a2af81 Merge pull request #5252 from miniak/doc-fix
Documentation fixes
2016-04-24 13:37:45 +09:00
Zeke Sikelianos ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Plusb Preco cbc2a869e3 📝 Fix typos
[ci skip]
2016-04-22 22:56:24 +09:00
Milan Burda da727a3c1b Fix display.rotation documentation 2016-04-22 12:32:11 +02:00
Ray Booysen 5a9b86dd05 Update screen.md 2016-04-18 17:04:47 +01:00
Cheng Zhao 04d626f0b0 docs: Document the display object
Fix #3571.
2016-01-07 20:21:11 +08:00
Cheng Zhao eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Eran Tiktin ea3e84e7ff Update screen.md
Removed a trailing comma.
2015-10-05 16:56:36 +03:00
Cheng Zhao 46c69cc3e5 docs: Removed unneeded changes from PR 2015-10-05 11:41:06 +08:00
hansrwindhoff 69140af083 example code didn't run 2015-10-04 20:14:52 -06:00