Commit Graph

89 Commits

Author SHA1 Message Date
Kamil Śliwak
42f982c063 docs: Fix indentation in some of the code snippets 2021-07-15 10:13:32 +02:00
Kamil Śliwak
5e3788874b Detailed documentation for path resolution in imports, including remappings, base path and standard input 2021-06-08 21:41:49 +02:00
Harikrishnan Mulackal
b605211d53
Merge pull request #11170 from ethereum/natspec-doc
Move improvements to the NatSpec documentation
2021-03-31 13:18:55 +02:00
Alex Beregszaszi
a99e0eb5cb Move improvements to the NatSpec documentation 2021-03-30 22:09:21 +01:00
chriseth
0c1be06cba Documentation for custom errors. 2021-03-30 23:04:32 +02:00
Alex Beregszaszi
78a66787d4 Improve documentation about NatSpec
Clarify the connection to Doxygen.
2021-03-24 16:14:48 +00:00
Alex Beregszaszi
7ac891600d Properly capitalise UTF-8/ASCII in the documentation 2021-03-24 16:09:00 +00:00
Hongbo Miao
cbea8241dd docs: fix semantic version link 2021-03-23 23:17:24 +08:00
dms-yondy
79e4c6da11 Fixed the grammer of a sentence in the docs 2021-02-16 09:44:31 +00:00
chriseth
5ffee049fa Merge remote-tracking branch 'origin/develop' into breaking 2020-11-03 14:05:14 +01:00
chriseth
631570c547 Documentation. 2020-11-03 13:31:51 +01:00
chriseth
0ea4bdafcd
Merge pull request #10017 from ethereum/develop
Merge develop into breaking.
2020-10-13 12:58:23 +02:00
chriseth
8a1bf41ac0
Merge pull request #10010 from ethereum/develop
Merge develop into breaking.
2020-10-12 15:33:34 +02:00
Kamil Śliwak
e1cc888369 Fix checkBaseABICompatibility() to make it actually check return parameters and not just ordinary parameters twice 2020-10-12 15:14:56 +02:00
Kamil Śliwak
692e4487ba Expand docs on mixed ABIEncoderV2 and V1 use 2020-10-12 13:27:03 +02:00
chriseth
14352ed921 Merge remote-tracking branch 'origin/develop' into HEAD 2020-10-08 20:18:04 +02:00
chriseth
df16515b52 Documentation. 2020-10-08 18:56:18 +02: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
cf5aa450bd Documentation. 2020-08-18 11:46:59 +02:00
Goh Chun Lin
f61e8ed05d
Corrected typo. 2020-07-31 22:53:12 +08: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
0148525aee Documentation changes. 2020-05-13 22:16:34 +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
Erik Kundt
fe1676203d Updates documentation to 0.7.0. 2020-01-10 18:56:38 +01:00
Leonardo Alt
997c547d67 Update contract layout SMTChecker 2019-12-12 16:43:10 +01:00
chriseth
86c83db901 Update layout. 2019-12-12 16:19:25 +01:00
chriseth
c175a468ab Do not call ABIEncoderV2 experimental. 2019-12-12 10:59:07 +01:00
chriseth
d8d8493550 Fix pragma version for testing. 2019-10-28 12:36:39 +01:00
Erik Kundt
ec53899a10 Fixes source extraction from docs. 2019-10-23 22:13:24 +02:00
Constantin Kloecker
7a240fbd97
fixed code block display
Added missing line
2019-04-10 11:17:40 +02:00
Leonardo Alt
9a612d1250 [SMTChecker] Docs 2019-03-27 16:31:51 +01:00
chriseth
9193fcb99f
Merge pull request #6130 from ethereum/docs-pragma
[DOCS] Updates to Pragma docs
2019-03-06 12:07:17 +01:00
Chris Ward
6dcc368183 Small polish to prgama docs
Fix issues

Reset non-typo
2019-03-06 12:01:50 +01:00
Chris Ward
3f5b5fdb8e Begin polish to import docs
Continue import polish
2019-03-06 11:06:46 +01:00
chriseth
8d401ba936 Update pragmas. 2019-03-05 18:10:09 +01:00
William Entriken
52fd20e98c Use latest version in code snippets. 2019-01-10 11:34:58 +01:00
Ricardo Guilherme Schmidt
c7e0965801 Add NatSpec to Style-Guide
related to #2270
2018-12-12 16:51:28 +01:00
Chris Ward
fa1cb346ae Update syntax used for input and output parameters 2018-11-14 14:20:49 +01:00
chriseth
525fa5109d
Clarify import. 2018-10-25 18:28:24 +02:00
chriseth
b43e9f27f8 Pitfalls regarding over/underflows 2018-09-27 14:55:05 +02:00
Alex Beregszaszi
2231df834d
Merge pull request #5088 from ethereum/morePragmas
[DOCS] Some more explanation about pragmas.
2018-09-25 20:09:32 +01:00
chriseth
3cec3f13e5 [DOCS] Some more explanation about pragmas. 2018-09-25 20:04:10 +02:00
Alex Beregszaszi
3ca00c73f9 Update version pragma in all documentation examples 2018-09-25 19:03:25 +01:00
chriseth
2c613127c9 Explain pragmas. 2018-09-18 15:16:40 +02:00
chriseth
540150a8fb Some more info about imports and comments. 2018-09-13 18:41:08 +02:00
Chris Ward
448118caec Clarify remapping
Update layout-of-source-files.rst
2018-09-04 13:49:01 +02:00
chriseth
6cf299bec6 Update documentation examples. 2018-08-14 15:50:46 +02:00