Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #4185

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
c29b932
add nonce to send options.
exx8 May 9, 2021
fb726ab
add nonce to send options.
exx8 May 9, 2021
70e4fda
Update CHANGELOG.md
exx8 May 9, 2021
9139352
linting
exx8 May 12, 2021
a277e69
Merge remote-tracking branch 'origin/1.x' into 1.x
exx8 May 12, 2021
f23e07c
merge
exx8 May 14, 2021
8899f35
updating docs
Jul 21, 2021
ab58050
update web3-shh.rst : whisper-overview broken link (#4170)
starwalker00 Jul 21, 2021
c61a335
[Docs] Fixed a broken link (#4151)
mongolsteppe Jul 21, 2021
9c31732
Possible typo in docs (#4088)
blackblather Jul 21, 2021
46f9f6b
Typically you will have only one Web3 connection, use const (#3967)
fulldecent Jul 21, 2021
33167fc
Removing deprecation notice for HttpProvider (#4008)
evertonfraga Jul 21, 2021
51bf795
[Docs] Updated solidity example to modern syntax (#4147)
mongolsteppe Jul 21, 2021
068d986
Merge branch '1.x' of https://github.com/exx8/web3.js into alex/updat…
Jul 21, 2021
cf32dcf
Update CHANGELOG with next anticipated version
spacesailor24 Jul 21, 2021
1c46aa7
npm i and build for v1.5.0-rc.0
spacesailor24 Jul 21, 2021
fb3af4b
v1.5.0-rc.0
spacesailor24 Jul 21, 2021
4779430
added EIP-2718 and EIP-1559 documentation
Jul 21, 2021
b0ea036
fixing typo
Jul 21, 2021
b650d1a
addressing feedback
Jul 21, 2021
1ad5608
changing possible types for maxPriorityFeePerGas
Jul 21, 2021
086ccd5
updating maxFeePerGas type
Jul 21, 2021
a73c5e9
Merge branch 'release/1.5.0' into alex/update-docs
Jul 21, 2021
a3e2e37
Update CHANGELOG.md
spacesailor24 Jul 21, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,4 +400,7 @@ Released with 1.0.0-beta.37 code base.

- Removing the underscore package

### Changed
- Docs are being updated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Docs are being updated
- Grammar fix and updated Swarm and Whisper doc links


## [Unreleased]
2 changes: 1 addition & 1 deletion docs/callbacks-promises-events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To help web3 integrate into all kinds of projects with different standards we pr
Most web3.js objects allow a callback as the last parameter, as well as returning promises to chain functions.

Ethereum as a blockchain has different levels of finality and therefore needs to return multiple "stages" of an action.
To cope with requirement we return a "promiEvent" for functions like ``web3.eth.sendTransaction`` or contract methods.
To cope with this requirement we return a "promiEvent" for functions like ``web3.eth.sendTransaction`` or contract methods.
This "promiEvent" is a promise combined with an event emitter to allow acting on different stages of action on the blockchain, like a transaction.

PromiEvents work like a normal promises with added ``on``, ``once`` and ``off`` functions.
Expand Down
2 changes: 1 addition & 1 deletion docs/web3-bzz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ web3.bzz


The ``web3-bzz`` package allows you to interact with swarm, the decentralized file store.
For more see the `Swarm Docs <http://swarm-guide.readthedocs.io/en/latest/>`_.
For more see the `Swarm Docs <https://docs.ethswarm.org/docs/>`_.


.. code-block:: javascript
Expand Down
2 changes: 1 addition & 1 deletion docs/web3-shh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ web3.shh
========


The ``web3-shh`` package allows you to interact with the whisper protocol for broadcasting. For more see `Whisper Overview <https://github.com/ethereum/go-ethereum/wiki/Whisper>`_.
The ``web3-shh`` package allows you to interact with the whisper protocol for broadcasting. For more see `Whisper Overview <https://eth.wiki/concepts/whisper/whisper-overview>`_.


.. code-block:: javascript
Expand Down