44 Commits
Author SHA1 Message Date
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
Denton Liu 7f940e498e Removed trailing whitespace 2016-05-06 09:53:06 -04:00
Denton Liu 7bc9777b70 Removed bulleted list 2016-05-06 09:42:05 -04:00
Denton Liu a3230d60c2 Made the style consistent 2016-05-05 14:41:35 -04:00
ssonicblue 570e7353b5 Update style-guide.rst
Update section 'Variable Declarations' for consistency with the format of the rest of the document.
2016-03-23 12:34:25 +08:00
Piper Merriam 3af5db99b8 fix spelling and heading title 2016-01-06 16:26:08 -07:00
Piper Merriam d1882bc753 use mixedCase 2015-12-17 08:57:02 -07:00
Piper Merriam d63ae5a5fa Flesh out naming convention section of docs 2015-12-16 16:21:04 -07:00
chriseth 92c789a89c Added some lost changes. 2015-12-07 23:35:39 +01:00
chriseth 64fa9ca478 Imported documentation. 2015-12-07 22:35:51 +01:00