Skip to content

Commit 6d32b8c

Browse files
Update docs with warnings
1 parent e781d17 commit 6d32b8c

File tree

5 files changed

+15
-4
lines changed

5 files changed

+15
-4
lines changed

docs/assembly.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,9 @@ of Solidity, you can use a special comment to annotate an assembly block as memo
381381
...
382382
}
383383
384-
Note that we will disallow the annotation via comment in a future breaking release; so, if you are not concerned with
385-
backward-compatibility with older compiler versions, prefer using the dialect string.
384+
.. warning::
385+
The ``memory-safe-assembly`` special comment will be deprecated in the next breaking version (0.9).
386+
So, if you are not concerned with backward-compatibility with older compiler versions, prefer using the dialect string.
386387

387388
Advanced Safe Use of Memory
388389
---------------------------

docs/contracts/functions.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,7 @@ will consume more gas than the 2300 gas stipend:
318318
you have to implement a receive Ether function (using payable fallback functions for receiving Ether is
319319
not recommended, since the fallback is invoked and would not fail for interface confusions
320320
on the part of the sender).
321+
Note that ``send`` and ``transfer`` are scheduled to be deprecated in the next breaking version (0.9).
321322

322323

323324
.. warning::

docs/contracts/inheritance.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,8 @@ explicitly:
427427
modifier foo() override(Base1, Base2) {_;}
428428
}
429429
430+
.. warning::
431+
virtual modifiers will be deprecated in the next breaking version (0.9).
430432

431433

432434
.. index:: ! constructor

docs/layout-of-source-files.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,13 @@ select between the two implementations of the ABI encoder and decoder.
103103
The new ABI coder (v2) is able to encode and decode arbitrarily nested
104104
arrays and structs. Apart from supporting more types, it involves more extensive
105105
validation and safety checks, which may result in higher gas costs, but also heightened
106-
security. It is considered
107-
non-experimental as of Solidity 0.6.0 and it is enabled by default starting
106+
security.
107+
It is considered non-experimental as of Solidity 0.6.0 and it is enabled by default starting
108108
with Solidity 0.8.0. The old ABI coder can still be selected using ``pragma abicoder v1;``.
109109

110+
.. warning::
111+
The ABI coder v1 will be deprecated in the next breaking version (0.9).
112+
110113
The set of types supported by the new encoder is a strict superset of
111114
the ones supported by the old one. Contracts that use it can interact with ones
112115
that do not without limitations. The reverse is possible only as long as the

docs/types/value-types.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,9 @@ reverts on failure.
261261
.. note::
262262
If ``x`` is a contract address, its code (more specifically: its :ref:`receive-ether-function`, if present, or otherwise its :ref:`fallback-function`, if present) will be executed together with the ``transfer`` call (this is a feature of the EVM and cannot be prevented). If that execution runs out of gas or fails in any way, the Ether transfer will be reverted and the current contract will stop with an exception.
263263

264+
.. warning::
265+
``transfer`` will be deprecated in the next breaking version (0.9).
266+
264267
* ``send``
265268

266269
``send`` is the low-level counterpart of ``transfer``. If the execution fails, the current contract will not stop with an exception, but ``send`` will return ``false``.
@@ -270,6 +273,7 @@ reverts on failure.
270273
(this can always be forced by the caller) and it also fails if the recipient runs out of gas. So in order
271274
to make safe Ether transfers, always check the return value of ``send``, use ``transfer`` or even better:
272275
use a pattern where the recipient withdraws the Ether.
276+
Please, be aware that ``send`` will be deprecated in the next breaking version (0.9).
273277

274278
* ``call``, ``delegatecall`` and ``staticcall``
275279

0 commit comments

Comments
 (0)