From 595b827a132026f9a16446aa394dd5eeb7521731 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 14 Jul 2016 16:09:29 -0700 Subject: [PATCH 1/2] Use common style to denote OS-specific arguments --- docs/api/process.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/api/process.md b/docs/api/process.md index 3bd8f1a4f2..1e953422b8 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -104,10 +104,7 @@ that all statistics are reported in Kilobytes. system. * `free` - The total amount of memory not being used by applications or disk cache. - -On Windows / Linux: - -* `swapTotal` - The total amount of swap memory in Kilobytes available to the - system. -* `swapFree` - The free amount of swap memory in Kilobytes available to the - system. +* `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the + system. _Windows_ _Linux_ +* `swapFree` Integer - The free amount of swap memory in Kilobytes available to the + system. _Windows_ _Linux_ From 7700c5e249c99efae02c110e7715db8d0826d20d Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 14 Jul 2016 16:10:19 -0700 Subject: [PATCH 2/2] denote return type on process memory info methods methods --- docs/api/process.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/process.md b/docs/api/process.md index 1e953422b8..2f618f240d 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -86,13 +86,13 @@ limit, whichever is lower for the current process. Returns an object giving memory usage statistics about the current process. Note that all statistics are reported in Kilobytes. -* `workingSetSize` - The amount of memory currently pinned to actual physical +* `workingSetSize` Integer - The amount of memory currently pinned to actual physical RAM. -* `peakWorkingSetSize` - The maximum amount of memory that has ever been pinned +* `peakWorkingSetSize` Integer - The maximum amount of memory that has ever been pinned to actual physical RAM. -* `privateBytes` - The amount of memory not shared by other processes, such as +* `privateBytes` Integer - The amount of memory not shared by other processes, such as JS heap or HTML content. -* `sharedBytes` - The amount of memory shared between processes, typically +* `sharedBytes` Integer - The amount of memory shared between processes, typically memory consumed by the Electron code itself ### `process.getSystemMemoryInfo()` @@ -100,9 +100,9 @@ that all statistics are reported in Kilobytes. Returns an object giving memory usage statistics about the entire system. Note that all statistics are reported in Kilobytes. -* `total` - The total amount of physical memory in Kilobytes available to the +* `total` Integer - The total amount of physical memory in Kilobytes available to the system. -* `free` - The total amount of memory not being used by applications or disk +* `free` Integer - The total amount of memory not being used by applications or disk cache. * `swapTotal` Integer - The total amount of swap memory in Kilobytes available to the system. _Windows_ _Linux_