#21 - Finalize doc of security package

Signed-off-by: Wright, Christopher R <Christopher.Wright@ca.com>
zowe · Sep 20, 2018 · c8faf85 · c8faf85
1 parent 7879f85
commit c8faf85
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/packages/security/src/InvalidCredentialManager.ts b/packages/security/src/InvalidCredentialManager.ts
@@ -16,6 +16,7 @@ import { BadCredentialManagerError } from "./errors/BadCredentialManagerError";
  * **NOTE** THIS CLASS SHOULD NOT BE EXPORTED FOR PUBLIC CONSUMPTION.
  *
  * This class is the fallback class when a credential manager fails to initialize.
+ * All methods in this class must throw te error passed in by the constructor.
  */
 export class InvalidCredentialManager extends AbstractCredentialManager {
     /**

diff --git a/packages/security/src/errors/BadCredentialManagerError.ts b/packages/security/src/errors/BadCredentialManagerError.ts
@@ -13,7 +13,7 @@ import { ImperativeError } from "../../../error";
 
 /**
  * This class represents the error thrown by methods of the {@link InvalidCredentialManager}
- * when initialized in the {@link CredentialManagerFactory}
+ * when initialized by {@link CredentialManagerFactory.initialize}
  */
 export class BadCredentialManagerError extends ImperativeError {
     /**