Commit Graph

3192 Commits

Author SHA1 Message Date
Kamil Śliwak
0400b435b8 Enable highlighting for more code blocks in the docs 2022-08-16 10:05:14 +02:00
minami
1706db2776 Fix underline 2022-08-16 01:15:29 +09:00
minami
b08454e49d Remove callcode in heading 2022-08-16 01:12:43 +09:00
Leo
c0e678033c
Merge pull request #12855 from aathan/patch-12
Rephrase named vs unnamed parameters in function definitions (in control-structures.rst).
2022-08-15 15:53:49 +02:00
Leo
a78a2bcf34
Merge pull request #13374 from 0xpranay/patch-2
Update the default free memory pointer in Yul.rst
2022-08-13 15:55:15 +02:00
Leo
1b8d7aae10
Merge pull request #13346 from minaminao/docs-abi-encoder-v2-default
Update description of input parameter type and return type limitations
2022-08-13 15:34:38 +02:00
Leo
b17559184a
Merge pull request #13256 from YuviTz1/develop
Added build flag to disable pedantic builds
2022-08-13 15:32:04 +02:00
Pranay
60d513c484
Updated yul.rst with feedback.
Updated yul.rst with explanation of 0x60 pointer choice.
2022-08-13 18:39:46 +05:30
Leo
5cf3973bb5
Merge pull request #12852 from aathan/patch-9
Update reference-types.rst
2022-08-13 15:09:33 +02:00
Leo
9dd2e0ec3f
Merge pull request #12954 from aathan/clarify-address-literals-eip-55
Link to address literals from address value types
2022-08-13 15:06:34 +02:00
minami
ec4ccf8183 Improve docs of possible function inputs and outputs 2022-08-13 14:48:20 +02:00
Leo
898ad25aab Review suggestions 2022-08-13 14:25:09 +02:00
aathan
18ce69ebbd Update reference-types.rst 2022-08-13 14:25:09 +02:00
Leo
681581d7f0
Merge pull request #12844 from aathan/patch-6
Update operators.rst
2022-08-13 14:25:07 +02:00
aathan
ffbb6f159e Update value-types.rst 2022-08-13 14:22:42 +02:00
aathan
0561bd6b00 Update control-structures.rst 2022-08-13 13:51:55 +02:00
aathan
9d5fb1bf8b Update operators.rst 2022-08-13 13:36:57 +02:00
aathan
f1a5bc7ed9 Update reference-types.rst
Clarify comment using language similar to that in the Array section of the documentation. Previously it said simply "Because of that..." but what the word "that" was about, was not evident.
2022-08-13 13:29:22 +02:00
Kamil Śliwak
b7847c9f07 installing-solidity.rst: Mention the PEDANTIC flag 2022-08-11 15:43:34 +02:00
Kamil Śliwak
3c0a7355d0
Merge pull request #13262 from xromrom/fixLinkToInternalFunctionCallsInDocs
[Docs] Fixed link to internal-function-calls
2022-08-10 19:07:08 +02:00
Daniel Kirchner
3a5b43eea3
Merge pull request #13286 from LCamel/contract_metadata_doc
Modify the metadata / hash document.
2022-08-10 18:19:10 +02:00
Daniel Kirchner
c4b0cb77ad
Merge pull request #13300 from krakxn/patch-1
Docs — Minor grammar fixes in `abi-spec.rst`
2022-08-10 18:17:49 +02:00
Roman Figurin
bbf6ecf69d [Docs] Updated a part about abicoder v2 and multi-dimensional array for external-function-calls 2022-08-10 16:09:33 +02:00
Roman Figurin
664b7bfbda [Docs] Fixed link to internal-function-calls 2022-08-10 16:09:14 +02:00
Pranay
6439955e83
Update the default free memory pointer in Yul.rst
The solidity docs and [Inline assembly memory management](https://docs.soliditylang.org/en/v0.8.15/assembly.html#memory-management) suggest the actual allocate-able memory starts from `0x80`. The above yul example defaults the free memory pointer to `0x60` in initialisation cases.
2022-08-10 13:54:02 +05:30
Daniel Kirchner
c2d4e03c55 Add blog post link to bug list. 2022-08-08 17:40:32 +02:00
Kamil Śliwak
caba38db5c Set release date for 0.8.16 and update the bug list 2022-08-08 14:12:42 +02:00
Marenz
22c7cd22b9 Fix wrong cleanup when copying from calldata to memory
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2022-08-08 13:07:16 +02:00
minami
796fb2cfad Fix description of this in free functions 2022-08-05 23:05:10 +02:00
LCamel
14f63cc7e8
Update docs/metadata.rst
Co-authored-by: Daniel Kirchner <daniel@ekpyron.org>
2022-08-03 22:12:11 +08:00
AN ❦
4d4a030a01 Minor grammar fixes 2022-08-03 02:02:16 +05:30
Quentin Garchery
b3fd11a66f
fix: global state object in yul formal specification 2022-07-28 11:12:14 +02:00
Luoh Ren-Shan (LCamel)
de857c27f3 Modify the metadata document. 2022-07-26 15:53:52 +08:00
chriseth
dd9a57b1fb
Merge pull request #13295 from minaminao/fix-dark-mode-bug
Fix dark mode bug
2022-07-25 21:03:03 +02:00
AN ❦
991174074e Minor grammar fixes 2022-07-25 21:01:00 +02:00
minami
98833b267f Fix dark mode bug 2022-07-25 04:26:45 +09:00
AN
b828da248f
Grammatical fixes 2022-07-23 21:21:28 +05:30
CJ42
ac5c26bbe9 docs: specifiy memory-safe in inline assembly is available since 0.8.13 2022-07-14 21:14:53 +02:00
maxisch
5567e30196
Modular Contracts typo fix 2022-07-13 09:02:29 -03:00
Richie
db2b066d40
tweak: update maximum line length 2022-07-08 11:41:51 -07:00
vdusart
f012a77980
Fix mistake 2022-07-07 13:48:20 +02:00
vdusart
eb6b1291b7
Fix type error
Fix type error according to #13144
2022-07-07 13:41:33 +02:00
Mathias L. Baumann
b02f64818b
Merge pull request #13096 from victorknox/develop
Moved Keywords section from 'Cheatsheet' to 'Units and Globally Available Variables'
2022-07-06 15:30:36 +02:00
Mathias L. Baumann
45f5616b12
Merge pull request #12679 from devtooligan/tweak/expand-collide-definition
tweak: expand definition of suggested collision naming convention
2022-07-06 15:04:40 +02:00
CJ42
e4d3425ad9 docs: add uint160 type in address conversion section
docs: add notice for uint conversion before 0.8.0

docs: edit sentence structure + remove 'result in `address payable`'

docs: add keyword 'explicitly' to be more specific for `address payable`

docs: edit notice uint to address conversion change since 0.8.0

Co-authored-by: Kamil Śliwak <cameel2@gmail.com>
2022-07-01 09:43:24 -03:00
victorknox
7445a4803f Moved Keywords section from 'Cheatsheet' to 'Units and Globally Available Variables' 2022-06-24 10:23:31 +05:30
Aiman Baharna
392b1872b3 docs: Disallow decimal literals with trailing dots
Currently the documentation suggests that a decimal literal can omit the
fractional part [1]:

> Decimal fractional literals are formed by a `.` with at least one
> number on one side. Examples include `1.`, `.1` and `1.3`.

However, commit ac68710 (May 30, 2018) disallowed trailing dots that are
not followed by a number [2].

Using decimal literals of the form `1.` will actually result in a
`ParserError` and so the docs should no longer recommend this form.

[1] https://docs.soliditylang.org/en/v0.8.15/types.html#rational-and-integer-literals
[2] ac68710789
2022-06-22 17:19:12 +01:00
Rohit Kumar Suman
9bc015071c
fix: Typo
Line 84!
By => With
to the them => to them
2022-06-19 11:56:03 +05:30
Femi Bolaji
d417fe135f
updated int assembly.rst (Sample program bug fix)
fixed for loop bug in VectorSum.sumPureAsm function at line 42
# updated { data := add(dataElementLocation, 0x20) } to ----->  { dataElementLocation := add(dataElementLocation, 0x20) }
 in order to update dataElementLocation after every iteration. (Hence ending the loop)
2022-06-17 10:48:48 +01:00
Daniel Kirchner
14d0776c94 Set release date for 0.8.15. 2022-06-15 15:08:24 +02:00
Daniel Kirchner
3f112280f8 Add warning comment to dangling references docs. 2022-06-15 14:52:37 +02:00
Daniel Kirchner
1cb8e17d94 Add documentation section about dangling references.
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2022-06-15 12:51:24 +02:00
Daniel Kirchner
27822dbca7 Remove entry in IR breaking changes. 2022-06-14 18:27:52 +02:00
Daniel Kirchner
187f0f070d Some review suggestions. 2022-06-14 18:27:52 +02:00
Daniel Kirchner
91ff02b988 Changelog and buglist entries. 2022-06-14 18:26:16 +02:00
Kamil Śliwak
dccc06cc29
Merge pull request #13135 from ethereum/foreign-event-access-revert-and-selector-cleanup
Revert access to foreign events and clean up event/error selector tests/docs
2022-06-14 18:14:30 +02:00
Kamil Śliwak
1ab84bb361 Put the table with operator precedence in a separate file, included in both Operators and Cheatsheet 2022-06-14 14:41:41 +02:00
Kamil Śliwak
f323cb2ef5 Improve index entries for selectors, events and selfdestruct 2022-06-14 12:05:49 +02:00
Kamil Śliwak
7785f46efd Document the .selector member for errors 2022-06-14 12:05:49 +02:00
Daniel Kirchner
3015afc504 Change severity of inline assembly bug to medium. 2022-06-13 17:18:13 +02:00
Daniel Kirchner
94dd6d0671 Bug list entry draft.
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2022-06-10 20:05:14 +02:00
Daniel Kirchner
01a794dd31
Merge pull request #13117 from ethereum/fixEmptyLinesInDocs
Remove all-whitespace lines from docs.
2022-06-09 15:41:47 +02:00
Mathias L. Baumann
cf1b9a5241
Merge pull request #13109 from sourabhxyz/develop
Fix commandline tests not detecting a snippet with a broken free function definition
2022-06-09 15:31:54 +02:00
Daniel Kirchner
4576333245 Remove all-whitespace lines from docs. 2022-06-09 15:00:03 +02:00
Denis T
811fa193af
Fix comment position in the voting example 2022-06-09 15:09:02 +03:00
sourabh.xyz
8405d167c1 using-for.rst: Fix free function visibility.
Example is incorrect in the sense that "Free functions" cannot have visibility specified.
2022-06-08 21:32:30 +02:00
Daniel Kirchner
f2c930588c
Merge pull request #13079 from uji/sort-grammer-rules
Sort grammar rules of SolidityLexer.g4
2022-06-08 12:55:59 +02:00
Prajwal Borkar
6061219641 Fix link to the optimizer step sequence in optimizer.rst 2022-05-31 15:41:22 +02:00
uji
5f6f353953 Sort grammer rules of SolidityLexer.g4 2022-05-30 00:15:48 +09:00
shady41
ecb7c0b008 Moved operator precedence from the cheatsheet to the operator docs 2022-05-25 23:07:51 +02:00
Dustin Alandzes
10c991c3ff
expect -> except in docs/contributing.rst 2022-05-24 23:14:21 -05:00
chriseth
f0e43921f7
Merge pull request #12921 from ethereum/add_event_and_error_selector_fields_on_the_line_of_function_selector_field
Adding event and error selector fields
2022-05-23 11:34:13 +02:00
nishant-sachdeva
d4c06d2b4e Adding event and error selector fields on the lines of the function selector fields 2022-05-23 10:49:16 +02:00
Josep M Sobrepere
5575bb9d99
nit: ABI docs use canonical representation 2022-05-21 23:29:25 +02:00
Samuel Osewa
2dee5dcfae Removed notes section 2022-05-20 15:41:35 +02:00
chriseth
0bd0bf4c7d Set release date. 2022-05-17 13:50:26 +02:00
chriseth
f427247993 Bug list entry. 2022-05-17 13:04:06 +02:00
alpharush
93755fcb70
document that pop does not return last element
It's already documented for push and this would clarify my incorrect assumption (that pop returns a value as in other languages) that caused confusion with https://github.com/ethereum/solidity/issues/13017
2022-05-13 09:45:55 -05:00
Daniel Kirchner
aafda389ea
Merge pull request #12907 from ethereum/calldataReencodeValidationBug
Calldatasize-check during ABI encoding from calldata values with nested dynamic arrays.
2022-05-12 17:56:44 +02:00
Leo Alt
2fe143f7d0 add changelog entry and docs note 2022-05-12 13:43:28 +02:00
Daniel Kirchner
352a3c5f4b Bug list entry, changelog entry and tests. 2022-05-12 13:08:30 +02:00
Florian Sey
c7d57031b5 Improve wording on voting example
From a beginner perspective, it is the first time in the documentation
that the term wallets is used. Other terms such as accounts or addresses
are explained in the Introduction to smart contracts.
2022-05-06 01:01:37 +02:00
Nobuhiko Otoba
f6c0edc902 Add a require statement to the Ballot contract 2022-04-30 12:51:59 +02:00
aathan
43ff61f185
Update functions.rst 2022-04-15 12:24:48 -07:00
Kamil Śliwak
e684b36b25
Merge pull request #12908 from tharun634/move-docs
Moved `docs.sh` script to `docs/`
2022-04-11 13:51:05 +02:00
sourabh.xyz
9867fbcfb0
Update inheritance.rst
Fixed typo 'owned' → 'Owned'.
2022-04-09 13:17:07 +05:30
Kamil Śliwak
23e77e9a84 docs.sh: Fail on all errors, includding undefined variables and failures in piped commands 2022-04-08 20:41:31 +02:00
Kamil Śliwak
efd0024853 docs.sh: Make the script independent of the working directory 2022-04-08 20:41:31 +02:00
Tharun K
a608bc12f7 Moved docs.sh script to docs/ 2022-04-08 20:41:22 +02:00
chriseth
22d8c0aecd Some updates to gas and delegatecall. 2022-04-07 21:34:36 +02:00
Kamil Śliwak
e340cf6ca2
Merge pull request #12876 from aathan/why-is-this-inline-assembly-not-memory-safe
[Docs] clarify the reason for the memory-unsafe assembly example being unsafe
2022-04-07 18:41:41 +02:00
aathan
9e2b26e046 Clarify the reason for the memory-unsafe assembly example being unsafe 2022-04-07 18:03:02 +02:00
Kamil Śliwak
0dd7f9c871
Merge pull request #12901 from aathan/clarify-base-contract-constructors
Clarify base contract constructors (re request of PR #12872)
2022-04-07 13:33:05 +02:00
andreb0x
60416120af Update introduction-to-smart-contracts.rst
modifying "write" to "transactions"
2022-04-07 10:05:46 +05:30
andreb0x
39f3175a37 updates to gas section
small modifications for clarity

updates to delegatecall

Update introduction-to-smart-contracts.rst

modifying "write" to "transactions"

updates to gas section

small modifications for clarity

Update introduction-to-smart-contracts.rst

modifying "write" to "transactions"

updates to gas section

small modifications for clarity

updates to delegatecall
2022-04-07 10:05:46 +05:30
aathan
fd0df0b05d
Update inheritance.rst 2022-04-05 12:19:59 -07:00
aathan
6f4844648f abstract-contracts.rst: Clarify when a contract may or must be marked abstract 2022-04-04 14:21:49 +02:00
aathan
54fa215885
Update mapping-types.rst
typo
2022-03-23 17:15:17 -07:00
aathan
07c9384b44
Update value-types.rst 2022-03-22 23:06:23 -07:00
Hector Roussille
040c444a2a Fixed ambiguity in the create2 address computation doc
specify that arguments are encoded using abi.encode in the example code
2022-03-16 19:56:11 +01:00