Commit Graph

57 Commits

Author SHA1 Message Date
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
chriseth
7a5be4a063
Merge pull request #12462 from semaraugusto/develop
[docs] fix issue with delegating votes to wallets who cannot vote.
2022-02-15 09:27:33 +01:00
Mohamed Safouen Bouabid
4c20821e6d Explaining payable(msg.sender)
At this point of the documentation a new Solidity learner will not understand this line without further explanation:
if (!payable(msg.sender).send(amount)) {
It should explain how msg.sender is of type "address" and not "address payable" so it cannot send or receive Ether. Therefore it must be explicitly converted to payable.
2022-01-10 12:49:30 +05:30
Esquith Allen
b1ef5de496 fix typo 2022-01-05 21:58:41 -05:00
Semar Augusto
6fbfa33486
Update docs/examples/voting.rst
Co-authored-by: Bhargava Shastry <bshastry@ethereum.org>
2021-12-29 07:04:13 -03:00
semaraugusto
942a3301dc fix issue with delegating votes to people who cannot vote. That made it so that if wallet A delegated to wallet B and B had no rights to vote, than B would lose out on its own vote 2021-12-29 00:17:15 -03:00
MrBrain295
ac64ae56a1 Minor rewording. 2021-10-14 15:09:18 +02:00
Ahmed Ali
e09b0ae15f Updated some examples following the naming convention
According to Solidity naming convention:
https://docs.soliditylang.org/en/latest/style-guide.html#naming-conventions There is no need to use
underscore except when there is a naming collision. In which case, a trailing underscore is used to
avoid the collision. So in this change, I am removing all underscores, except for the ones that
could shadow other symbols in their context (none of the changed names is a reserved keyword:
https://docs.soliditylang.org/en/latest/cheatsheet.html?highlight=reserved#reserved-keywords )
2021-08-26 11:59:10 +02:00
Sreekesh V
9b9e52e53e updated public to external for the functions
changed public to external for the functions
2021-08-12 16:24:40 +02:00
Kamil Śliwak
693b88e5f8 docs: Force highlighter to work despite errors on snippets that it cannot parse 2021-07-15 10:14:00 +02:00
iskanderandrews
a8e9d7a80d docs/
Enhancing all the .rst doc files by adding highlighting for the code snippets, including the following langs:
1. Solidity

2. bash

3. javascript

4. assembly
2021-06-25 12:33:55 +02:00
Kamil Śliwak
056e0d3751 docs: Suppress highlighting errors for snippets that cause errors in pygments-lexer-solidity 2021-06-21 20:54:35 +02:00
patekuru
5787bc921d
Update micropayment.rst 2021-06-19 08:50:51 -04:00
Behrouz
05e1b72709
Fix a typo 2021-04-08 22:50:40 +04:30
chriseth
786ae2ceec Use errors in examples. 2021-03-30 23:04:32 +02:00
chriseth
0c1be06cba Documentation for custom errors. 2021-03-30 23:04:32 +02:00
zayneio
3643024fb0 Fix typo in documentation 2021-03-28 17:02:18 -04:00
ghidello
b37723dc36
[DOCS] Update OpenZeppelin's ECDSA contract URL 2021-03-21 11:38:04 +01:00
Sanad
110b4df1ff
Update blind-auction.rst 2021-02-16 12:09:58 +00:00
Rostyslav
92251d054d Updating grammar
I have changed pronounce "their" to his/her, she/he to clarify the working process of the smart contract.
2021-02-09 19:38:35 +01:00
hrkrshnn
88c99a7538 Tests/Docs: changing type of msg.sender and tx.origin into address
And also making the type of address(literal) as non-payable address.
2020-12-14 16:55:48 +01:00
chriseth
4bdec8107c Merge remote-tracking branch 'origin/develop' into HEAD 2020-09-29 09:53:50 +02:00
Harikrishnan Mulackal
8339765509 [DOCS] Change >=0.7.0 to ^0.7.0 2020-09-28 13:02:31 +02:00
Harikrishnan Mulackal
710231e2b1 Docs: change >0.6.99 <0.8.0 to >=0.7.0 2020-09-28 11:14:45 +02:00
chriseth
efe829b4b2
Merge pull request #9805 from ethereum/develop
Merge develop into breaking.
2020-09-14 20:48:03 +02:00
John B Nelson
59533792b4 Add missing word to examples doc explainer 2020-09-11 11:14:25 -07:00
Mathias Baumann
b72fb1333b Adjust docs example to work with v0.8.0 2020-09-08 13:36:16 +02:00
Kamil Śliwak
192954e8fa docs: Fix broken internal links using wrong syntax
- These links were using external link syntax instead of `:ref:`. What's
  worse, Sphinx can't detect when they're broken.
- Added missing anchors in some cases.
2020-08-31 12:46:45 +02:00
chriseth
479d7a059f Documentation. 2020-07-07 12:16:18 +02:00
chriseth
257bc6a416 Merge remote-tracking branch 'origin/develop' into breaking 2020-05-14 13:04:46 +02:00
chriseth
d33b67b3c2 Add license tags to documentation snippets. 2020-05-13 22:16:34 +02:00
Harikrishnan Mulackal
a207613f17 Docs, changelog and tests 2020-05-05 21:11:15 +05:30
chriseth
6728e3ef94 Merge remote-tracking branch 'origin/develop' into breaking 2020-04-22 17:21:32 +02:00
iamdefinitelyahuman
d59706e5f5 docs: fix formatting errors and style inconsistencies 2020-04-20 20:24:31 +04:00
Black3HDF
c7e0983cef
fix link 2020-04-08 22:46:59 +08:00
chriseth
51883958ab Merge remote-tracking branch 'origin/develop' into breaking 2020-04-07 11:14:28 +02:00
Djordje Mijovic
64ae889dd7 Enabling pragma with > in minimum version check 2020-03-31 23:50:24 +02:00
chriseth
7d68f9f6c3 Merge remote-tracking branch 'origin/develop' into breaking 2020-03-24 13:35:41 +01:00
Erik Kundt
50c22f0800 Adds script which compiles docs example with minimum compiler version. 2020-03-18 19:27:38 +01:00
chriseth
4d681fb16d Merge remote-tracking branch 'origin/develop' into HEAD 2020-01-14 16:43:48 +01:00
Erik Kundt
fe1676203d Updates documentation to 0.7.0. 2020-01-10 18:56:38 +01:00
William Entriken
6d068b6331 Reduce usage of the word "kill" 2020-01-07 11:18:10 +01:00
Leonardo Alt
7a2893842d Docs Solidity by example 2019-12-13 16:19:49 +01:00
Bhargava Shastry
bdcebf36cb Docs: Minor change to micropayment example section 2019-12-12 18:16:36 +01:00
chriseth
3f48dfae6a Update examples (1) 2019-12-12 17:04:19 +01:00
chriseth
d199db698e [DOCS] Add more explanation and withdraw pattern. 2019-11-25 23:45:13 +01:00
Chris Chinchilla
30e843a217 State what default value of enum in example is
Fix formatting issue and add mention of the enum default type

Other files
2019-06-24 14:32:53 +02:00
chriseth
0e864467de [Docs] Better explain the modular approach. 2019-05-23 14:02:44 +02:00
Constantin Kloecker
5936f52aa5
fixed code block display 2019-03-23 11:38:59 +01:00