From bb097e7ae76acf9ccfbb6303312a2dbceacee568 Mon Sep 17 00:00:00 2001 From: Daehyun Paik Date: Thu, 30 May 2019 17:23:25 +0900 Subject: [PATCH] Replace method names of mining operation in doc Currently, some method names in documentation are not same with (implementation)[https://github.com/ethereum/web3.js/blob/1.0/packages/web3-eth-miner/types/index.d.ts#L42]. These two methods are related to RPC method `miner_start` and `miner_stop`. --- docs/web3-eth-miner.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/web3-eth-miner.rst b/docs/web3-eth-miner.rst index 6ce1e3a64b3..4c5c0c3920d 100644 --- a/docs/web3-eth-miner.rst +++ b/docs/web3-eth-miner.rst @@ -146,12 +146,12 @@ Example ------------------------------------------------------------------------------ -start +startMining ===== .. code-block:: javascript - miner.start(miningThread, [, callback]) + miner.startMining(miningThread, [, callback]) Start the CPU mining process with the given number of threads. The RPC method used is ``miner_start``. @@ -180,21 +180,21 @@ Example .. code-block:: javascript - miner.start('0x1').then(console.log); + miner.startMining('0x1').then(console.log); > true - miner.start(1).then(console.log); + miner.startMining(1).then(console.log); > true ------------------------------------------------------------------------------ -stop +stopMining ==== .. code-block:: javascript - miner.stop([callback]) + miner.stopMining([callback]) Stop the CPU mining process. The RPC method used is ``miner_stop``. @@ -222,7 +222,7 @@ Example .. code-block:: javascript - miner.stop().then(console.log); + miner.stopMining().then(console.log); > true ------------------------------------------------------------------------------