Commit Graph

225 Commits

Author SHA1 Message Date
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
Alex Beregszaszi
5f89e1a2ac Merge the constructor sections 2016-10-19 14:02:50 +01:00
Alex Beregszaszi
f8795afc70 Mention why Homestead was different for libraries 2016-10-19 14:02:50 +01:00
Alex Beregszaszi
1b3713742f Document constant functions 2016-10-19 14:02:50 +01:00
Alex Beregszaszi
111d33d7ac Rename sha3 to keccak256 in the documentation 2016-10-06 16:34:41 +02:00
chriseth
4f5a95d569 Update documentation to version 0.4.0. 2016-09-06 19:11:41 +02:00
chriseth
453490cb61 Merge pull request #1003 from winsvega/docs
add "pragma solidity ^0.4.0;" to code examples
2016-09-06 15:59:49 +02:00
chriseth
02984b8de1 Require ";" after "_" 2016-09-05 14:54:50 +02:00
Dimitry
183cd70c47 add "pragma solidity ^0.4.0;" to code examples 2016-09-05 14:54:54 +03:00
chriseth
9a91bd80ab Clarify warning. 2016-08-30 15:37:10 +02:00
chriseth
eb241ff1b3 Documentation. 2016-08-30 15:32:28 +02:00
Denton Liu
f125b2813e Clean up contracts.rst 2016-08-26 17:13:45 -04:00
chriseth
83160d56f3 Merge pull request #953 from Denton-L/fallback-stuff
Write about what fallback functions cannot do
2016-08-26 17:01:38 +02:00
Denton Liu
8c3b1334ae Add "Sending Ether" 2016-08-26 10:31:57 -04:00
chriseth
21b6aa92ff Disallow fallback function to return values. 2016-08-26 00:07:50 +02:00
Denton Liu
f5989fb5e0 Correct spacing 2016-08-25 15:44:16 -04:00
Denton Liu
c276086f3f Write about what fallback functions cannot do 2016-08-25 15:43:04 -04:00
chriseth
f329d5e772 Merge pull request #925 from mocamircea/patch-10
Update contracts.rst
2016-08-25 18:06:30 +02:00
Mircea Moca
55be44dd5f Update contracts.rst
I left the example with contract C only, showing the access specifiers discussed at 186-188. The specifier of data is left public since nothing is related to accessor functions now.

Added a separate example with contracts C, D and E to show specifier's effect. 

Added a separate example to prove the synthesizing of accessor functions.

Added a new example to show the internal/external call of the accessor, according to existent discussion.
2016-08-25 11:43:17 +03:00
Denton Liu
1655f3b7bf Update contracts.rst 2016-08-24 11:43:55 -04:00
Denton Liu
ac799aff0e Remove trailing whitespaces 2016-08-24 11:43:55 -04:00
Dave Hoover
1bb53ad3e7 Small documentation update 2016-08-23 22:53:30 -05:00
Mircea Moca
01dc055d42 Update contracts.rst
I think it's more clear now and without the risk of mentioning the yet discussed accessor concept
2016-08-19 17:47:57 +03:00
Mircea Moca
ee51894e73 Update contracts.rst
Extended example according to the discussed stuff, clarification & typos
2016-08-18 14:16:01 +03:00
chriseth
9c83109549 BREAKING: return only exits current function/modifier 2016-08-17 11:29:31 +02:00
chriseth
d5e536a4fb Made snippet work as is. 2016-08-01 12:14:17 +02:00
cseberino
a20e03135b Update contracts.rst 2016-08-01 12:12:06 +02:00
Manidos
fe45221952 Update contracts.rst
I've changed line 88, because **if (msg.sender == creator)** threw an exception in solidity browser compier.

Untitled:25:13: Error: Operator == not compatible with types address and contract TokenCreator
        if (msg.sender == creator)
            ^-------------------^
2016-07-27 13:27:56 +06:00
chriseth
2df142c496 Security Considerations 2016-07-04 15:27:53 +02:00
Dave Hoover
b31bd4a2e4 Fixing library examples that don't compile.
Addressing https://github.com/ethereum/solidity/issues/684
2016-06-25 07:11:45 -05:00
chriseth
b23c300792 Merge pull request #658 from graup/graup-patch-1
Fix typo in Libraries section
2016-06-21 17:52:35 +02:00
Fabio Berger
9272c8ab32 Fix two documentation typos 2016-06-20 01:41:46 +01:00
Paul Grau
6aa069403a Fix typo in Libraries section 2016-06-17 23:13:03 +02:00
Denton Liu
49f5bc7ce9 Changed inline code syntax
Changed from :code:`<inline>` to ``<inline>``
2016-05-30 09:44:33 -04:00
Denton Liu
c8e4ba4b52 Modified contracts.rst
Changed inline code syntax
2016-05-30 09:42:30 -04:00
Denton Liu
d29b9b986e Changed link from markdown to rst
Added labels for the links to point to
2016-05-18 17:17:05 -04:00
Denton Liu
c851cd0481 Corrected capitalisation of symbol names 2016-05-18 17:17:05 -04:00
Denton Liu
7c22a387f3 Changed whitespace formatting 2016-05-18 11:35:32 -04:00
Denton Liu
bb62a8b3fd Replaced all tabs with spaces 2016-05-18 11:23:47 -04:00
Denton Liu
8bbe99ad11 More code-style corrections 2016-05-18 11:23:47 -04:00
Alex Melville
38940ddfa5 fix example solidity contract code by adding argument to constructor 2016-05-15 17:16:44 -07:00
Denton Liu
565866dd87 Reformatted according to style guide 2016-05-05 14:58:02 -04:00
Denton Liu
768b778615 Update contracts.rst
Corrected grammar error
2016-05-05 14:01:50 -04:00
chriseth
7e0a1863de Documentation. 2016-05-05 13:36:32 +02:00
chriseth
d0bb87ae88 Documentation for delegatecall. 2016-03-11 17:49:59 +01:00
uberlaufer
770d509af6 Update contracts.rst 2016-03-10 20:55:53 +01:00
uberlaufer
ec3800b28e shortened lines to 79 2016-03-10 20:53:13 +01:00
uberlaufer
ac03a08bec Update contracts.rst
minor grammar and spelling corrections
2016-03-10 19:12:16 +01:00
holgerd77
aec2f4879a Added in-depth links to function modifiers, structs and enums in structure section 2016-02-19 12:05:56 +01:00
u2
af2e4c0673 docs: code sytle 2015-12-30 20:56:46 +08:00
chriseth
8fe89455b3 Fixes in the misc section. 2015-12-21 16:54:32 +01:00
chriseth
5622011bc5 Note about private note being invisible. 2015-12-14 16:22:52 +01:00
chriseth
64fa9ca478 Imported documentation. 2015-12-07 22:35:51 +01:00