Merge branch 'development' into feature/deployer-improvements

3 files changed, 26 insertions, 4 deletions

diff --git a/packages/deployer/src/compiler.ts b/packages/deployer/src/compiler.ts
index 712169c89..1f521dca1 100644
--- a/packages/deployer/src/compiler.ts
+++ b/packages/deployer/src/compiler.ts
@@ -33,6 +33,10 @@ import { utils } from './utils/utils';
 
 const ALL_CONTRACTS_IDENTIFIER = '*';
 
+/**
+ * The Compiler facilitates compiling Solidity smart contracts and saves the results
+ * to artifact files.
+ */
 export class Compiler {
     private _contractsDir: string;
     private _networkId: number;
@@ -96,7 +100,7 @@ export class Compiler {
         this._specifiedContracts = opts.specifiedContracts;
     }
     /**
-     * Compiles selected Solidity files and writes JSON artifacts to artifactsDir.
+     * Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
      */
     public async compileAsync(): Promise<void> {
         await createArtifactsDirIfDoesNotExistAsync(this._artifactsDir);
diff --git a/packages/deployer/src/deployer.ts b/packages/deployer/src/deployer.ts
index 6c247d328..68518a931 100644
--- a/packages/deployer/src/deployer.ts
+++ b/packages/deployer/src/deployer.ts
@@ -19,12 +19,21 @@ import { utils } from './utils/utils';
 // Gas added to gas estimate to make sure there is sufficient gas for deployment.
 const EXTRA_GAS = 200000;
 
+/**
+ * The Deployer facilitates deploying Solidity smart contracts to the blockchain.
+ * It can be used to build custom migration scripts.
+ */
 export class Deployer {
     public web3Wrapper: Web3Wrapper;
     private _artifactsDir: string;
     private _networkId: number;
     private _defaults: Partial<TxData>;
 
+    /**
+     * Instantiate a new instance of the Deployer class.
+     * @param opts Deployer options, including either an RPC url or Provider instance.
+     * @returns A Deployer instance
+     */
     constructor(opts: DeployerOptions) {
         this._artifactsDir = opts.artifactsDir;
         this._networkId = opts.networkId;
@@ -42,8 +51,8 @@ export class Deployer {
         this.web3Wrapper = new Web3Wrapper(web3Provider, this._defaults);
     }
     /**
-     * Loads contract artifact and deploys contract with given arguments.
-     * @param contractName Name of the contract to deploy. Must match name of an artifact in artifacts directory.
+     * Loads a contract's corresponding artifacts and deploys it with the supplied constructor arguments.
+     * @param contractName Name of the contract to deploy. Must match name of an artifact in supplied artifacts directory.
      * @param args Array of contract constructor arguments.
      * @return Deployed contract instance.
      */
@@ -80,7 +89,8 @@ export class Deployer {
         return contractInstance;
     }
     /**
-     * Loads contract artifact, deploys with given arguments, and saves updated data to artifact.
+     * Loads a contract's artifact, deploys it with supplied constructor arguments, and saves the updated data
+     * back to the artifact file.
      * @param contractName Name of the contract to deploy. Must match name of an artifact in artifacts directory.
      * @param args Array of contract constructor arguments.
      * @return Deployed contract instance.
diff --git a/packages/deployer/src/monorepo_scripts/stage_docs.ts b/packages/deployer/src/monorepo_scripts/stage_docs.ts
new file mode 100644
index 000000000..e732ac8eb
--- /dev/null
+++ b/packages/deployer/src/monorepo_scripts/stage_docs.ts
@@ -0,0 +1,8 @@
+import { postpublishUtils } from '@0xproject/monorepo-scripts';
+
+import * as packageJSON from '../package.json';
+import * as tsConfigJSON from '../tsconfig.json';
+
+const cwd = `${__dirname}/..`;
+// tslint:disable-next-line:no-floating-promises
+postpublishUtils.publishDocsToStagingAsync(packageJSON, tsConfigJSON, cwd);