Commit Graph

108 Commits

Author SHA1 Message Date
minaminao
cd8636105d Replace python with Python 2023-03-28 22:59:05 +09:00
William Entriken
6216842458 Add recommendation for leading underscore, see #11764
Update docs/style-guide.rst

Co-authored-by: Nuno Santos <nunofilipesantos@gmail.com>

Update docs/style-guide.rst

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>

Update docs/style-guide.rst

Co-authored-by: Nikola Matić <nikola.matic@ethereum.org>
2023-02-22 07:31:51 +01:00
Kamil Śliwak
986bc361b1 docs: Replace some links with redirects found by linkcheck 2023-02-01 12:26:44 +01:00
William Entriken
8f705fc327 [Documentation] set error placement in contract, match example to prescription
Add example

fix order
2022-11-21 15:52:41 +01:00
Richie
db2b066d40
tweak: update maximum line length 2022-07-08 11:41:51 -07:00
Mathias L. Baumann
45f5616b12
Merge pull request #12679 from devtooligan/tweak/expand-collide-definition
tweak: expand definition of suggested collision naming convention
2022-07-06 15:04:40 +02:00
Richie
49f06dacdf fix: remove lower_case_with_underscores and Capitalized_Words_With_Underscores from code examples 2022-02-21 10:53:35 -08:00
Richie
635ca409f8 fix: shorten line length per code review 2022-02-16 12:06:33 -08:00
Richie
e2d87c1bcc tweak: expand definition of suggested collision naming convention 2022-02-15 19:35:11 -08:00
William Entriken
9d94870770 Fix typos 2022-02-15 19:17:05 -05:00
Younghoon-Lee
95f9289f2c Add blank line to make it consistency 2022-01-28 01:11:35 +09:00
Bruno Barbieri
9a13917049
Add modifiers to the order of layout 2022-01-20 20:20:30 -05:00
Saska Karsi
105de2561a
rm trailing comma in style-guide.rst example 2021-12-03 01:11:04 +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
Kamil Śliwak
f3a5c27852 docs: Replace a few remaining :: blocks with .. code-block:: 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
Alex Beregszaszi
a99e0eb5cb Move improvements to the NatSpec documentation 2021-03-30 22:09:21 +01:00
chriseth
561280a5cc Merge remote-tracking branch 'origin/develop' into breaking 2020-12-14 11:33:40 +01:00
Kamil Śliwak
0f6f4314b6 Fix code snippets in docs not passing tests on versions matching their pragmas 2020-12-12 04:52:16 +01:00
chriseth
04195439b7 Merge remote-tracking branch 'origin/develop' into HEAD 2020-11-09 14:28:05 +01:00
Eric Bouchut
950245e384 Fix typos: onlyOwner not mixed case
Fix the modifier name `onlyowner` using lowercase where mixedCase is expected.
2020-11-04 18:02:32 +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
Mathias Baumann
b72fb1333b Adjust docs example to work with v0.8.0 2020-09-08 13:36:16 +02:00
Kamil Śliwak
26ccb98222 docs: Update old external links to use HTTPS where possible 2020-08-31 12:46:45 +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
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
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
Chris Chinchilla
f46218cad9 Update pragma versions for 0.6.0 2019-12-16 17:36:44 +01:00
Leonardo Alt
3198f55d24 Docs style guide 2019-12-13 12:40:33 +01:00
Mathias Baumann
5b8ff78176 Implement virtual keyword 2019-11-14 11:49:39 +01:00
Daniel Kirchner
3321fc56ea Split fallback function and introduce "fallback()" and "receive()" syntax. 2019-11-04 17:17:58 +01:00
Alexander Arlt
cd3ad73b5a Update tests. 2019-11-01 14:54:47 -05:00
Mathias Baumann
6c6a9054b2 Implement override checking 2019-10-30 17:31:33 +01:00
chriseth
57def9e8b4
Merge pull request #7395 from balajipachai/patch-2
Fixed typo at the end of the file
2019-09-10 12:29:49 +02:00
Balaji Pachai
27fb79dc10
Fixed typo at the end of the file
Changed `annontated` to `annotated`
2019-09-10 15:52:06 +05:30
Balaji Pachai
8fe4fe7921
Fixed a typo
Replaced is with in to make the statement grammatically correct.
2019-09-10 15:35:52 +05:30
Balaji Pachai
45d6d4567e
Fixed a typo
Changed proceeded to preceded, making the statement grammatically correct.
2019-09-10 15:17:58 +05:30
Chris Chinchilla
f99d78117e Bring code examples for Style Guide inline with style guide
Add back accidentally removed public
2019-06-05 15:25:18 +02:00
William Entriken
f1be1b2758
Learn how to spell section 2019-05-29 21:02:03 -04:00
William Entriken
916e151f46 Add NatSpec documentation. 2019-04-19 00:54:08 +02:00