Commit Graph

202 Commits

Author SHA1 Message Date
chriseth
17493e64ed Documentation. 2018-06-25 17:17:18 +02:00
Leonardo Alt
8862b3092b C99 scoping rules by default 2018-06-20 12:53:38 +02:00
chriseth
3eebba1087 Clarify documentation about events (mostly topics). 2018-06-19 19:53:02 +02:00
Harry Moreno
20a5a9b15f
Update Event emit docs pragma
Event's `emit` usage was introduced in 0.4.21+
2018-06-07 15:07:07 -04:00
chriseth
c2e4c4651a
Merge pull request #4216 from kronosapiens/patch-2
Update function visibility example
2018-06-04 19:33:54 +02:00
Daniel Kronovet
1a603625d4
Denote getData as view 2018-06-04 15:00:55 +03:00
Daniel Kronovet
a217cd05c9
Fix typo 2018-06-03 15:36:54 +03:00
Daniel Kronovet
0d4adc44c9
Update function visibility example
Two functions don't access state and should be `pure`. Also, inconsistent spacing when using arithmetic.
2018-06-03 12:25:52 +03:00
William Morriss
648bb484ac consistency: unordered list for restrictions 2018-05-29 16:56:45 -07:00
João Vítor
899bd5f39a
clarify warnings in contracts.rst
closes #4117
2018-05-27 21:58:58 -03:00
Daniel Kirchner
f5a49f679a Adjust tests. 2018-05-16 18:32:47 +02:00
chriseth
54839fdffb
Merge pull request #4101 from mesqueeb/patch-2
Extra line of explanation on Abstract contracts.
2018-05-16 10:21:33 +02:00
Luca Ban
e670004b1f
fixed capitalisation and contractions 2018-05-16 17:03:53 +09:00
Daniel Kirchner
1a014f83cc Prefer view over constant in the documentation. 2018-05-09 15:06:47 +02:00
Luca Ban
bb7a393756
Extra line of explanation on Abstract contracts.
And why they're useful.
2018-05-09 19:28:55 +09:00
chriseth
1e95335589
Merge pull request #4074 from elopio/docs/implicit-constructor
docs: document the implicit call of base constructor without arguments
2018-05-09 11:08:34 +02:00
Leo Arias
114a0cf953 document that all the base constructors are called 2018-05-08 17:26:37 +00:00
Leo Arias
a9f2936f27 docs: update the explanation of constructor 2018-05-05 21:45:14 +00:00
Leo Arias
4259c0d036 docs: document the implicit call of base constructor without arguments 2018-05-05 21:41:47 +00:00
chriseth
8782508e0b Update documentation about C3 linearization. 2018-04-30 16:15:41 +02:00
Matthew Ludwig
cf347745bd Updated constructors and pragma solidity lines.
Updated the Inheritance section of the docs in order to correct old constructor formats and update them to the new constructor() format.
2018-04-20 16:50:00 -04:00
chriseth
af18b4deb8
Merge pull request #3885 from LefterisJP/update_solidity_version_where_revert_with_reason
Docs: Update solidity version for revert with reason
2018-04-16 19:55:56 +02:00
chriseth
8be4cba570
Merge pull request #3865 from ethereum/updateConstructorVersionPragmas
[MERGE WITH RELEASE 0.4.22] Update version pragmas in constructor documentation.
2018-04-16 19:55:34 +02:00
Lefteris Karapetsas
8a7224683b
Docs: Update solidity version for revert with reason 2018-04-15 23:12:28 +02:00
chriseth
344a388d44 Update documentation. 2018-04-12 13:09:38 +02:00
Daniel Kirchner
2192e4035a Update version pragmas from >0.4.21 to ^0.4.22. 2018-04-12 10:43:00 +02:00
Federico Bond
4e037281ac Error on duplicated super constructor calls 2018-04-09 11:22:35 +02:00
Roman
86c5d6aaad
hash256 -> bytes32 fix in misleading note
As it was described here: https://ethereum.stackexchange.com/questions/44628/understanding-low-level-interface-to-logs/44629?noredirect=1#comment52316_44629
2018-04-04 09:02:58 +03:00
Daniel Kirchner
3ae326139a Document absence of constructors. 2018-04-03 18:21:55 +02:00
Daniel Kirchner
f855c78a08 Update version pragma and use new constructor syntax in std/ contracts. 2018-04-03 18:21:55 +02:00
bitshift
07c74ef924 Updates docs to new constructor syntax. 2018-04-03 18:21:55 +02:00
Haoliang Yu
826de65e2d
fix a wrong number 2018-04-02 22:22:38 -04:00
chriseth
3057aeece4 Document STATICCALL usage in experimental 0.5.0. 2018-03-06 15:32:45 +01:00
Oleksii Matiiasevych
5d486b741f
Revert warning update about view modifier 2018-03-06 14:19:59 +07:00
chriseth
3793aa405b
Merge pull request #3643 from ethereum/gasleft
Move msg.gas to global function gasleft(). Closes #2971.
2018-03-05 20:11:37 +01:00
Daniel Kirchner
b8589fbe0f Use msg.value and gasleft() as an example in the docs. 2018-03-05 16:59:33 +01:00
Daniel Kirchner
c633c0eacb Move msg.gas to global function gasleft(). Closes #2971. 2018-03-05 11:18:04 +01:00
Furkan Ayhan
c2730a4893
Correct warning message in Pure Functions doc
wrong commit that caused this: (64eaff6420 (diff-754689a291c0a19b500c31eb6c1d30c7R506))
2018-03-04 13:23:07 +03:00
bernard peh
cde4e3172b change the language so that it doesn't sound like send and transfer is providing the stipend 2018-03-02 23:40:17 +11:00
bernard peh
2c086cb90b clarify 2300 gas stipend in fallback function section 2018-03-02 16:25:52 +11:00
Elena Dimitrova
c9840c98f4 Documentation updates for internal constructors and function signature (#3365)
* Add a note explaining return values not included in function signature

* Add section on Constructors in documentation

* Improve documented definition for abstract contract

* Add benefits of abstraction to documentation
2018-03-01 16:59:47 +01:00
wbt
92fe9e621e Note deprecation of constant keyword on functions 2018-02-27 00:08:17 +01:00
Alex Beregszaszi
64eaff6420 Random documentation updates (assembly, faq) 2018-02-26 20:19:26 +01:00
chriseth
f58024b974 Documentation about emitting events. 2018-02-22 15:17:42 +01:00
chriseth
20d8254029
Merge pull request #3427 from duaraghav8/patch-3
Abstract Contracts: Add note about function type
2018-02-21 18:04:35 +01:00
chriseth
09887de266
Fix link. 2018-02-19 19:02:49 +01:00
hyperfekt
b4fb7255dd
fixes ethereum/solidity#1209
This clears up a common and easy misunderstanding which seems to occur rather often.
(https://ethereum.stackexchange.com/questions/8263/trying-to-understand-libraries)
2018-01-26 15:32:11 +01:00
chriseth
e7afde9587
Merge pull request #3203 from ethereum/nocall
Prevent libraries from being called.
2018-01-25 16:45:54 +01:00
ZoOgY-DoOgY
4f753233f7
Inheritance, "super" and DDD
As explained in "Multiple Inheritance and Linearization" part, "a simple rule to remember is to specify the base classes in the order from “most base-like” to “most derived”". So "contract Final is Base1, Base2" means Final is derived from Base2, derived from Base1, so the final inheritance sequence should be, starting with the most derived contract : Final, Base2, Base1, mortal, owned.
2018-01-24 13:38:47 +01:00
Raghav Dua
694fc6835f
correct terminology 2018-01-23 23:43:04 +05:30
Raghav Dua
18539e5353
Abstract Contracts: Add note about function type 2018-01-23 23:23:18 +05:30
Maurelian
31aaf4336a Add comment to clarify example (#3415)
* Add comment to clarify example

* Reverse bases.
2018-01-23 18:14:56 +01:00
chriseth
f7315d19bd Document call protector. 2018-01-19 16:52:23 +01:00
Chuck LeDuc Díaz
efc198d515 Minor syntax and formatting changes (#3337)
* Copyediting, mostly syntax.

* Use consistent quote chars inside sample code comments

* Revert to put back matching parenthesis

* Use single backticks for comment code quotes

wherever a reserved word, function or variable name is used in a comment
2017-12-20 10:48:22 +01:00
Jim McDonald
6e521d59b0 Fix Solidity warnings 2017-12-12 18:47:30 +00:00
elenadimitrova
c6a4aba9f0 Document function overloads and resolution 2017-12-12 10:26:58 +02:00
wbt
2ebc9953e4
Minor update in contracts
Fix typos and prevent example code from needing horizontal scroll bar
2017-11-29 14:21:21 -05:00
Alex Beregszaszi
23379e1061 Ensure each code snippet in the docs can be extracted for tests 2017-11-22 04:08:35 +00:00
Martín Triay
ab4f97a80b Update contracts.rst
Fixed web3 URL
2017-09-27 13:59:26 -03:00
Lefteris Karapetsas
7f88d43937
docs: Specify gas fallback function from call
Specify that also 21k gas is needed for fallback functions originating from
external function calls.
2017-09-21 14:15:13 +02:00
Alex Beregszaszi
135c55c4d0 Overhaul contract creation section in the documentation (add reference to remix and web3.js) 2017-09-13 09:53:56 +01:00
Alex Beregszaszi
88bce877c4 Clarify some subtleties of the fallback function 2017-09-01 19:16:52 +01:00
Alex Beregszaszi
412cc6bc58 Highlight opcodes in docs 2017-08-28 11:59:35 +01:00
Alex Beregszaszi
dd2cc899bb Fix lists and links 2017-08-28 11:59:35 +01:00
Alex Beregszaszi
2af949baaa Explain the limitations of view and pure 2017-08-25 12:49:53 +01:00
Alex Beregszaszi
bb493bf52d Require 0.4.16 for view/pure in docs examples 2017-08-25 12:37:23 +01:00
Alex Beregszaszi
93e6e83093 Document pure functions 2017-08-24 13:46:18 +01:00
Alex Beregszaszi
b1cdf81506 Document view functions 2017-08-22 18:25:46 +01:00
chriseth
2021508653 Update contracts.rst 2017-08-16 11:31:50 +02:00
Isaac Ibiapina
2dc9e53a49 Specify address as string on events documentation 2017-08-15 14:57:10 -04:00
chriseth
8ee973f316 Merge pull request #2660 from jamesray1/patch-26
Constructor index in docs/contracts.rst
2017-08-15 17:43:29 +02:00
James Ray
064918c94a Constructor is not a solidity keyword
Removed backticks
2017-07-28 15:31:03 +10:00
James Ray
c5b82f7d50 Constructor index
For referencing, especially when it hasn't been mentioned but not discussed in detail previously e.g. here and here.
2017-07-28 15:24:19 +10:00
James Ray
bc8d7d4a5d Updated link for getter-functions 2017-07-28 11:30:53 +10:00
Nathan Hernandez
99b6411853 Fix typo in contracts.rst
Changed `internall` to `internally`.
2017-07-27 01:46:53 -04:00
Alex Beregszaszi
cffe52d6d9 Enable more examples in the documentation for testing 2017-07-19 00:05:05 +01:00
Alex Beregszaszi
41e5b2c3c2 Fix bugs in example contracts 2017-07-13 21:47:29 +02:00
James Ray
7471220cb4 Added ref for Getter functions 2017-07-01 13:29:20 +10:00
chriseth
bab470086c Merge pull request #2364 from VoR0220/abiSpec
Bring ABI Spec Into Solidity Documentation
2017-06-14 17:25:31 +02:00
chriseth
d47fcbb612 Clarify statement about receiving ether
Fixes #2377
2017-06-13 19:08:13 +02:00
chriseth
ca70d82b96 Include abi specs in index and fix styling. 2017-06-12 18:33:23 +02:00
chriseth
2d8b866b59 Merge pull request #2278 from ethereum/chriseth-patch-2
Fix bug in example contract.
2017-05-17 14:26:02 +02:00
chriseth
2c3eea7e42 Fix bug in example contract. 2017-05-17 11:30:45 +02:00
greggdourgarian
2ed1b3d6d2 remove extraneous 's' 2017-05-03 14:07:14 -05:00
greggdourgarian
d13a1f4f7b minor punctuation, typo and clarity changes 2017-05-03 12:24:00 -05:00
chriseth
7e838fd4a8 Cleanup to make the docs more consistent. 2017-05-03 12:03:02 +02:00
Matt Wisniewski
2b4b86aa7f Update common-patterns.rst 2017-05-03 12:03:02 +02:00
Morgan
fb58809c20 Update contracts.rst 2017-04-17 21:41:28 -04:00
Matt Searle
ca3ceb4de2 Fix typo 2017-03-27 17:19:08 +13:00
Alex Beregszaszi
d5102c1db7 Disallow constructor in interfaces 2017-03-17 17:06:52 +00:00
Alex Beregszaszi
2c4bce2d62 Disallow enums in interfaces 2017-03-17 17:06:52 +00:00
Alex Beregszaszi
3f1468142b Document interfaces 2017-03-17 17:06:51 +00:00
Alex Beregszaszi
b053b6164e Fix typo (recieve to receive) 2017-03-16 11:20:39 +00:00
chriseth
c65d506811 Documentation update. 2017-03-13 13:30:23 +01:00
chriseth
bdbd3b158e Extend documentation for constant state variables. 2017-03-13 13:30:23 +01:00
chriseth
592cec7e90 Disallow constants that are neither value types nor strings. 2017-03-13 13:30:23 +01:00
chriseth
4077e56a2f Documentation. 2017-03-13 13:30:23 +01:00
Alex Beregszaszi
ace583d0a1 Rename accessor to getter 2017-02-03 00:17:21 +00:00
Yoichi Hirai
bd6e65a89c
docs: document the resriction about a function and an event of the same name, and so on 2017-01-11 18:28:11 +01:00
Yoichi Hirai
c33b098e55
docs: add a description about the types of parameters of overriding functions 2016-11-23 16:40:57 +01:00