electron/docs/api
Bret Comnes 46af3cefec Clarify remote require of relative modules
The docs for the `remote.require(module)` method were a little too terse for me to understand the behavior of relative module loading for `remote.require` and I had to run an experiment to understand the behavior (e.g. is the relative path relative to caller of `remote.require` or relative to some other path in the project related to the main process?).   I think this is correct but someone please double check my understanding.

Adding an example and additional explanation should help clarify this.  Feel free to edit the copy as needed.
2017-03-13 15:42:26 -07:00
..
structures Add docs for segmented control touch bar item 2017-03-10 17:50:23 +11:00
accelerator.md Link Accelerator docs to globalShortcut module 2016-10-26 14:48:09 +02:00
app.md fix indentation of app.setLoginItemSettings arguments 2017-03-02 13:28:58 -08:00
auto-updater.md Add Squirrel Release Server to the update server list. 2017-01-12 13:40:14 +00:00
browser-window-proxy.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
browser-window.md Mark TouchBar as experimental 2017-03-07 09:42:45 -08:00
chrome-command-line-switches.md --cipher-suite-blacklist is also removed 2017-02-06 10:34:29 -08:00
client-request.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
clipboard.md use https for all Electron website URLs 2017-02-28 21:19:55 -08:00
content-tracing.md contentTracing.setWatchEvent/cancelWatchEvent is removed 2017-02-06 10:34:28 -08:00
cookies.md Put optional label before dash 2016-12-29 14:11:26 -08:00
crash-reporter.md Pass uploadToServer parameter to linux crash reporter 2017-03-09 17:23:52 -03:00
debugger.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
desktop-capturer.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
dialog.md move platform labels to end of description for consistency 2017-03-02 13:57:04 -08:00
download-item.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
environment-variables.md Move variables from development to production 2016-12-22 09:22:04 -08:00
file-object.md document process(es) for all APIs 2016-11-03 10:26:00 -07:00
frameless-window.md Remove excess newlines 2016-10-27 10:42:31 -07:00
global-shortcut.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
incoming-message.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
ipc-main.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
ipc-renderer.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
locales.md Sort by codes 2016-11-23 09:10:27 -08:00
menu-item.md Add forcereload to MenuItem doc 2017-02-03 09:39:41 -08:00
menu.md use https for all Electron website URLs 2017-02-28 21:19:55 -08:00
native-image.md Add more default values 2017-03-09 10:26:44 -08:00
net.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
power-monitor.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
power-save-blocker.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
process.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
protocol.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
remote.md Clarify remote require of relative modules 2017-03-13 15:42:26 -07:00
screen.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
session.md Capitalize type 2017-03-07 21:25:40 +11:00
shell.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
synopsis.md Update url (#7598) 2016-10-13 14:09:14 -07:00
system-preferences.md Fix a typo, there => their 2016-12-21 19:21:04 -08:00
touch-bar-button.md Link more touch bar params 2017-03-08 13:04:55 -08:00
touch-bar-color-picker.md Add more explicit types to docs for TouchBar 2017-03-04 16:14:41 +11:00
touch-bar-group.md Link more touch bar params 2017-03-08 13:04:55 -08:00
touch-bar-label.md Add more explicit types to docs for TouchBar 2017-03-04 16:14:41 +11:00
touch-bar-popover.md Link more touch bar params 2017-03-08 13:04:55 -08:00
touch-bar-segmented-control.md Add docs for segmented control touch bar item 2017-03-10 17:50:23 +11:00
touch-bar-slider.md Add more explicit types to docs for TouchBar 2017-03-04 16:14:41 +11:00
touch-bar-spacer.md fix TouchBarSpacer class name in doc 2017-03-05 15:09:57 +09:00
touch-bar.md Link more touch bar params 2017-03-08 13:04:55 -08:00
tray.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
web-contents.md Updated docs. 2017-03-09 09:54:09 -05:00
web-frame.md purgedSize and purgeableSize are removed by Chrome 2017-02-06 10:34:29 -08:00
web-request.md link process annotations to glossary 2016-12-21 13:47:40 -08:00
webview-tag.md Removed webrtcippolicy attribute from webview 2017-03-08 13:52:04 -05:00
window-open.md Link to return class type 2016-12-19 09:40:07 -08:00