Fix documentation

sindresorhus · Oct 13, 2019 · a92abc0 · a92abc0
1 parent 1a5d1cb
commit a92abc0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -254,12 +254,16 @@ declare namespace execa {
 		killed: boolean;
 
 		/**
-		The name of the signal that was used to terminate the process.
+		The name of the signal that was used to terminate the process. For example `"SIGFPE"`.
+
+		If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
 		*/
 		signal?: string;
 
 		/**
-		A human-friendly description of the signal that was used to terminate the process.
+		A human-friendly description of the signal that was used to terminate the process. For example `"Floating point arithmetic error"`.
+
+		If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
 		*/
 		signalDescription?: string;
 	}

diff --git a/readme.md b/readme.md
@@ -270,13 +270,17 @@ Whether the process was killed.
 
 Type: `string | undefined`
 
-The name of the signal that was used to terminate the process.
+The name of the signal that was used to terminate the process. For example `"SIGFPE"`.
+
+If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
 
 #### signalDescription
 
 Type: `string | undefined`
 
-A human-friendly description of the signal that was used to terminate the process.
+A human-friendly description of the signal that was used to terminate the process. For example `"Floating point arithmetic error"`.
+
+If a signal terminated the process, this property is defined and included in the error message. Otherwise it is `undefined`.
 
 #### originalMessage