William Entriken
916e151f46
Add NatSpec documentation.
2019-04-19 00:54:08 +02:00
chriseth
8d401ba936
Update pragmas.
2019-03-05 18:10:09 +01:00
Chris Ward
0c1affe43e
Begin documentation style guide
...
Add pragma to documentation style guide
Fix formatting and add link
Move docs style guide
Changes from review
2019-02-27 11:48:51 +01:00
Ricardo Guilherme Schmidt
c7e0965801
Add NatSpec to Style-Guide
...
related to #2270
2018-12-12 16:51:28 +01:00
Chris Ward
bbe0268163
Add mapping guide to style docs thanks to @aupiff
2018-12-03 10:43:53 +01:00
Alex Beregszaszi
3ca00c73f9
Update version pragma in all documentation examples
2018-09-25 19:03:25 +01:00
Alex Beregszaszi
6f758a6c95
Include pragma in 'Order of Layout' in the style guide
2018-09-18 15:06:49 +01:00
Chris Ward
98bc9ac326
Added order of layout to style guide
2018-09-18 15:37:16 +02:00
chriseth
8a06000a30
Update documentation.
2018-08-14 15:50:46 +02:00
Luke Schoen
835c05cb3a
Update style guide with regards to CapWords requirement for contract and file naming.
2018-08-06 18:23:58 +02:00
Cryptomental
eb92d5f760
docs: Fix typos.
...
Used codespell and manual fixes.
Refs: #4442
2018-07-10 22:57:59 +02:00
Leo Arias
8fdf3f5d45
update the style guide
2018-07-04 04:29:00 +00:00
chriseth
eeef82b2d7
Fallback function has to be external: backwards-compatible changes.
2018-06-29 00:23:52 +02:00
Daniel Kirchner
1a014f83cc
Prefer view over constant in the documentation.
2018-05-09 15:06:47 +02:00
Leo Arias
aff19a1009
docs: clarify the maximum line length style
2018-04-24 10:27:35 -06:00
wbt
8aadc179ae
Fix small formatting issue
...
in which a constant was not treated as code, inconsistent with surrounding examples.
2018-03-30 15:28:15 -04:00
chriseth
cf6720eab5
Merge pull request #3587 from OTTTO/develop
...
Multiline output parameters and return statements
2018-03-01 12:07:09 +01:00
Dax Bondye
e34d367593
Multiline output parameters and return statements
2018-02-26 19:32:55 -08:00
chriseth
97d1c70491
Merge pull request #3575 from OTTTO/develop
...
Recommend to explicitly label the visibility of functions.
2018-02-22 22:41:29 +01:00
Dax Bondye
2ac49b3c2d
Reccomend to explicitly label the visibility of functions.
2018-02-22 10:23:20 -08:00
chriseth
71a34abd87
Merge pull request #3513 from OTTTO/develop
...
Add "Maximum Line Length" section
2018-02-22 16:12:49 +01:00
DYLAN BECKWITH
187e50b14c
Recommend consistent style for wrapping long lines.
2018-02-22 07:01:07 -08:00
William Entriken
5497a85158
Clarify name documentation for mixedCase
2018-01-29 14:45:36 -05:00
wbt
1948b9687f
Case convention clarification
...
Constructors follow the contract naming convention, using CapWords, instead of mixedCase.
2018-01-16 13:08:20 -05:00
William Entriken
cb5758aa75
Prefer CapWords style struct names
2018-01-14 13:53:45 -05:00
Jim McDonald
6e521d59b0
Fix Solidity warnings
2017-12-12 18:47:30 +00:00
Kamuela Franco
ef57961711
Update style-guide.rst to include enum style
2017-12-09 14:53:40 +00:00
Christian Pamidov
f9b240096f
Fixed typos ( #3139 )
2017-10-28 12:48:57 +01:00
Svetlin Nakov
58778be567
Fixed typos
2017-10-25 22:58:18 +03:00
Svetlin Nakov
f39cf7be41
Improved the "Naming" section
...
Improved the "Naming" section. Added naming examples. Improved consistency.
2017-10-25 10:33:26 +03:00
Alex Beregszaszi
2d8b0fdc39
Fix inconsistent use of single backticks
2017-03-15 23:41:02 +00:00
ethers
217f33c252
Clearer language as suggested by @axic
2016-11-22 00:47:58 -08:00
ethers
feebe3e755
Fallback functions don't always have to be payable
2016-11-17 18:14:26 -08:00
ethers
1d9aee97c2
styleguide: Don't include a whitespace in the fallback function
2016-11-17 18:13:33 -08:00
ethers
549bca1494
Don't include a whitespace in fallback function
2016-11-17 18:09:22 -08:00
ethers
39559c1bb6
styleguide: Ordering of functions
...
Ordering would help readers identify which functions they can call, and to find the "specials" (constructor and fallback function). Mixing the "specials" in the middle of the code, as well as internal functions between external and public functions, don't help readers
Based on https://github.com/ConsenSys/MultiSigWallet/issues/19
2016-11-17 18:06:28 -08:00
chriseth
4f5a95d569
Update documentation to version 0.4.0.
2016-09-06 19:11:41 +02:00
Raghav Dua
fe3ef7f09c
typo
2016-09-06 14:54:06 +05:30
Denton Liu
f1e6bc2eaa
Update style-guide to use new style
2016-08-26 13:33:42 -04:00
Denton Liu
2a492f59c9
Add double-quotes to style guide
2016-08-11 11:10:47 -04:00
ethers
70f7df6430
mixedCase for modifiers
2016-07-14 03:29:15 -07:00
chriseth
00c89cdb49
Merge pull request #555 from Denton-L/single-line-functions
...
Added a Clause in Style Guide about Single Line Function Declarations
2016-06-21 17:16:56 +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
09a7fb7f6b
Modified style-guide.rst
...
Corrected inline code syntax
2016-05-30 09:44:33 -04:00
Denton Liu
5903ca451f
Corrected "who's" to "whose"
2016-05-18 17:17:05 -04:00
Denton Liu
f8fcd1bc26
Changed do_something to doSomething
...
This is in accordance to the style guide
2016-05-18 17:17:05 -04:00
Denton Liu
b6fd6ddc99
Change whitespace section to include exception
...
For single-line functions, some whitespace padding
makes the functions slightly more readable.
2016-05-11 15:16:18 -04:00
Denton Liu
d4125c4f07
Changed do_something to doSomething
...
This is in accordance to the style guide
2016-05-11 15:16:18 -04:00
mario02423
873c54106c
Update style-guide.rst
...
Removed extraneous comma from line 366
2016-05-09 15:42:57 -05:00
Denton Liu
7e94a1d84d
Added a clause about short functions
2016-05-06 10:19:28 -04:00
