PR feedback

microsoft · Dec 7, 2023 · 8e81f71 · 8e81f71
1 parent cde66f7
commit 8e81f71
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/common/reviews/api/node-core-library.api.md b/common/reviews/api/node-core-library.api.md
@@ -752,19 +752,13 @@ export interface IWaitForExitResult<T extends Buffer | string | never = never> {
     stdout: T;
 }
 
-// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@rushstack/node-core-library" does not have an export "IRunToCompletionOptions"
-//
-// @public (undocumented)
+// @public
 export interface IWaitForExitWithBufferOptions extends IWaitForExitOptions {
-    // (undocumented)
     encoding: 'buffer';
 }
 
-// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@rushstack/node-core-library" does not have an export "IRunToCompletionOptions"
-//
-// @public (undocumented)
+// @public
 export interface IWaitForExitWithStringOptions extends IWaitForExitOptions {
-    // (undocumented)
     encoding: BufferEncoding;
 }
 

diff --git a/libraries/node-core-library/src/Executable.ts b/libraries/node-core-library/src/Executable.ts
@@ -125,20 +125,26 @@ export interface IWaitForExitOptions {
 }
 
 /**
- * {@inheritDoc IRunToCompletionOptions}
+ * {@inheritDoc IWaitForExitOptions}
  *
  * @public
  */
 export interface IWaitForExitWithStringOptions extends IWaitForExitOptions {
+  /**
+   * {@inheritDoc IWaitForExitOptions.encoding}
+   */
   encoding: BufferEncoding;
 }
 
 /**
- * {@inheritDoc IRunToCompletionOptions}
+ * {@inheritDoc IWaitForExitOptions}
  *
  * @public
  */
 export interface IWaitForExitWithBufferOptions extends IWaitForExitOptions {
+  /**
+   * {@inheritDoc IWaitForExitOptions.encoding}
+   */
   encoding: 'buffer';
 }
 
@@ -529,7 +535,7 @@ export class Executable {
     const { throwOnNonZeroExitCode = false, encoding } = options;
     if (encoding && (!childProcess.stdout || !childProcess.stderr)) {
       throw new Error(
-        'An encoding was specified, but stdout and/or stderr are not piped. Did you set stdio?'
+        'An encoding was specified, but stdout and/or stderr on the child process are not defined'
       );
     }