Update docs #4185
Closed
Update docs #4185
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original link gives out a 404, replaced by the closest thing I could find.
I think the author missed a "this" in the phrase
|
Your Render PR Server URL is https://web3-js-pr-4185.onrender.com. Follow its progress at https://dashboard.render.com/static/srv-c3s66g47o9q6rmiaact0. |
CHANGELOG.md
Outdated
| @@ -400,4 +400,7 @@ Released with 1.0.0-beta.37 code base. | |||
|
|
|||
| - Removing the underscore package | |||
|
|
|||
| ### Changed | |||
| - Docs are being updated | |||
There was a problem hiding this comment.
Suggested change
| - Docs are being updated | |
| - Grammar fix and updated Swarm and Whisper doc links |
Co-authored-by: Gregory Markou <[email protected]>
* Removing deprecation notice for HttpProvider From my view, it is just a provider with less capabilities than websockets, but still widely useful — and widely used as well. @frozeman @nivida @GregTheGreek any thoughts? * Update include_package-core.rst * Update CHANGELOG.md Co-authored-by: Gregory Markou <[email protected]> Co-authored-by: Alex <[email protected]>
* [Docs] Updated solidity example to modern syntax Replaced the old constructor function syntax with the modern one, added 'emit' to event calls, added pragma, added a valid bytes32 value and updated the JSON ABI. * [Docs] Fixed a broken link (#1) Original link gives out a 404, replaced by the proper guide. Co-authored-by: Juan Alonso <[email protected]> * Revert "[Docs] Fixed a broken link (#1)" This reverts commit 0de1272. Co-authored-by: Juan Alonso <[email protected]>
Pull Request Test Coverage Report for Build 1053718577
💛 - Coveralls |
docs/web3-eth.rst
Outdated
| @@ -1419,17 +1421,21 @@ Parameters | |||
| - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction. | |||
| - ``gas`` - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded). | |||
| - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to :ref:`web3.eth.gasPrice <eth-gasprice>`. | |||
| - ``type`` - ``Number|String|BN|BigNumber``: (optional) A positive unsigned 8-bit number between 0 and 0x7f that represents the type of the transaction. | |||
| - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total | |||
| - ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee) | |||
There was a problem hiding this comment.
Suggested change
| - ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee) | |
| - ``maxPriorityFeePerGas`` - ``Number|String|BN|BigNumber`` (optional, defaulted to ``1 Gwei``) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee) |
docs/web3-eth.rst
Outdated
| @@ -1419,17 +1421,21 @@ Parameters | |||
| - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction. | |||
| - ``gas`` - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded). | |||
| - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to :ref:`web3.eth.gasPrice <eth-gasprice>`. | |||
| - ``type`` - ``Number|String|BN|BigNumber``: (optional) A positive unsigned 8-bit number between 0 and 0x7f that represents the type of the transaction. | |||
| - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total | |||
There was a problem hiding this comment.
Suggested change
| - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional) The maximum fee per gas that the transaction is willing to pay in total | |
| - ``maxFeePerGas`` - ``Number|String|BN|BigNumber``: (optional, defaulted to ``(2 * block.baseFeePerGas) + maxPriorityFeePerGas``) The maximum fee per gas that the transaction is willing to pay in total |
remove merge conflict indicator
spacesailor24
previously approved these changes
Jul 21, 2021
spacesailor24
suggested changes
Jul 21, 2021
There was a problem hiding this comment.
Should not be merge in current state
alex/update-docs was branched off of release/1.5.0 and needs to be merged into 1.x, so that 1.x can be merged into release/1.5.0. All changes should be replicated in a branch that's based off of 1.x
This commit needs to be reverted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updating documents with relevant changes
Please include a summary of the changes and be sure to follow our Contribution Guidelines.
Type of change
Checklist:
CHANGELOG.mdfile in the root folder.