Commit Graph

2352 Commits

Author SHA1 Message Date
ethers
91f4ae12a9
remove SHA-3 as Keccak-256 is clearer
Reduce confusion as Keccak-256 is clear enough
2020-06-08 19:16:24 -07:00
Igor Line
3841b2626b
Fix semantic urls for function and modifier overriding in documentation 2020-06-06 16:57:26 +02:00
chriseth
fc4b3e33b7 Prepare 0.6.9. 2020-06-04 14:25:04 +02:00
chriseth
6f75476f52 Fix documentation about return values. 2020-06-02 18:09:50 +02:00
Alex Beregszaszi
0a71e41501
Merge pull request #9072 from FlashSheridan/patch-5
Fix grammar and remove redundant words
2020-05-29 23:04:12 +01:00
Flash Sheridan
36b54561a5
Fix grammar and remove redundant words 2020-05-29 17:09:15 -04:00
Flash Sheridan
7ce760388f
Spell-check 2020-05-29 16:50:05 -04:00
Christian Parpart
09485058d8 Adds `--base-path to solc when compiling in --standard-json mode for resolving relative paths. 2020-05-27 16:23:03 +02:00
chriseth
add55fd793 Documentation. 2020-05-26 10:51:13 +02:00
a3d4
a499ef16fa Fix spelling errors 2020-05-25 02:54:37 +02:00
Alexander Arlt
af8bb5fb60 Allow natspec comments on state variables. 2020-05-19 11:01:52 -05:00
William Entriken
3e8b9bdb1c Add NatSpec for public state variables 2020-05-19 11:01:52 -05:00
Leonardo Alt
5d6dd68766 Update docs 2020-05-18 17:09:46 +02:00
Leonardo Alt
d4d26c02e4 Assume that push will not overflow 2020-05-18 16:35:56 +02:00
chriseth
a16a8c6123 Sort and copyedit changelog. 2020-05-14 12:36:04 +02:00
chriseth
504b8d29c9
Merge pull request #8907 from ethereum/licenseIdentifier
Check for SPDX license identifiers.
2020-05-14 01:21:24 +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
Mathias Baumann
820fdd9bf7 Escape backslashes when formatting 2020-05-13 17:08:37 +02:00
Daniel Kirchner
6f04664cfa Disallow array slicing for arrays with dyanmically encoded base types. 2020-05-13 15:52:22 +02:00
Daniel Kirchner
3fbde6e782
Merge pull request #8856 from ethereum/implicitConstructorCallvalueCheck
Implicit constructor callvalue check
2020-05-11 18:50:36 +02:00
Daniel Kirchner
79b217dfb3 Callvalue checks for implicit constructors. 2020-05-11 16:14:34 +02:00
chriseth
3312150d7f
Merge pull request #8878 from ethereum/selecting-yul-optimisation-steps-in-strict-assembly-mode
Selecting Yul optimisation steps in strict assembly mode
2020-05-11 16:05:57 +02:00
Harikrishnan Mulackal
c0c5127ed0 Changed a potentially misleading name 2020-05-11 19:05:41 +05:30
Harikrishnan Mulackal
091abcea8c Updated docs for type(X).min and type(X).max 2020-05-11 16:19:55 +05:30
Kamil Śliwak
e8aec6de54 More information about --yul-optimizations option in READMEs and docs 2020-05-08 22:29:57 +02:00
Kamil Śliwak
dc5612467f docs/yul: Use backtick syntax correct for RST in the docs for --yul-optimizations 2020-05-08 22:29:57 +02:00
Kamil Śliwak
6a58227830 CommandLineInterface: Make --yul-optimizations work in strict assembly mode 2020-05-08 22:29:57 +02:00
chriseth
38486f47a7 Example ERC20 contract in Yul. 2020-05-04 19:13:50 +02:00
Kamil Śliwak
457cc754d0 docs: Info about optimizerSteps field in Standard JSON input and metadata listings 2020-05-04 15:59:44 +02:00
Kamil Śliwak
d037f7a3c5 docs: Info about --yul-optimizations and optimizer steps in Yul section 2020-05-04 15:59:44 +02:00
chriseth
ea7e751750 Documentation. 2020-05-04 15:05:14 +02:00
chriseth
d7180c0522 Prepare 0.6.7. 2020-05-04 12:57:27 +02:00
chriseth
b627f3ab85
Merge pull request #8808 from ethereum/documentation-abstract
Note on abstract contract about overriding implemented functions
2020-05-01 13:33:55 +02:00
KaiYu Feng
15748e871e
fix(docs/mapping-types): fix wrong demo code.
get index before push, so the access of this index won't beyond the boundery.
2020-05-01 00:14:45 +08:00
hrkrshnn
d1fd6782bc Note on abstract contract about overriding implemented functions 2020-04-30 19:41:31 +05:30
chriseth
3828adbbbd
Merge pull request #8761 from ethereum/conditonalStrings
Conditional strings for Whiskers.
2020-04-27 14:07:30 +02:00
Alex Beregszaszi
025daaada5
Merge pull request #8765 from ethereum/interfaceId-doc-miscellaneous-fix
docs/cheatsheet.rst: Add ``type(I).interfaceId`` description.
2020-04-27 12:26:53 +01:00
chriseth
aa8107f45a Conditional strings for Whiskers. 2020-04-27 11:07:56 +02:00
Noel Maersk
a481ea719f
docs: use Yul lexer to highlight Yul code segments.
Many commits squashed; turns out that with the combination of:

* Python v2.7,
* Sphinx v1.8.5, and
* Pygments v2.3.1

versions (old!) used in the CI, the only viable approach is:

* to use `code-block` directives with explicit language specification,
* to provide no file-local default using `highlight`, and
* to set language as `none` for grammar specifications.

Underlying are the following issues (again, for the old versions
listed above):

* Generic RST `code` doesn't work when language is `none`:

    Warning, treated as error:
    /root/project/docs/yul.rst:430:Cannot analyze code. No Pygments lexer found for "none".

  Additionally, it might be trying to fall back to the default
  (Solidity) if left unspecified.

* If a file-local default is specified using `highlight`, then
  `code-block` _must_ also provide a language:

    Warning, treated as error:
    /root/project/docs/yul.rst:185:Error in "code-block" directive:
    1 argument(s) required, 0 supplied.

* Sphinx seems to try the file-local default "yul" (specified with
  `highlight`) on `code` marked having language `json`:

    Warning, treated as error:
    /root/project/docs/yul.rst:130:Could not lex literal_block as "yul". Highlighting skipped.

* The only well-lexed highlighter for two of the three grammar
  specifications is `peg`, but it was added in Pygments v2.6.
  One of the grammars - in the "Formal Specification" section,
  the one after "We will use a destructuring notation for the
  AST nodes." - _must_ be left unhighlighted, with language set
  to `none`: all lexers do really poorly.

... And one should never, ever start treating warnings as mere
warnings, without having exhausted all other options.

Otherwise, it's a slippery slope, - and look where that brought
Gandhi: to being a strawman in every lousy argument to be had!..
2020-04-26 20:48:07 +03:00
Alexander Arlt
55eda85a30 docs/cheatsheet.rst: Add `type(I).interfaceId` description. 2020-04-24 08:09:45 -05:00
chriseth
d429d20b0b Restructure documentation and improve TOC. 2020-04-23 19:05:42 +02:00
hrkrshnn
48ff9fd4d6 Tests, Changelog and updated grammar 2020-04-23 17:27:37 +05:30
chriseth
a371910674
Merge pull request #8642 from ethereum/interfaceid
Add support for interfaceId.
2020-04-23 12:24:49 +02:00
chriseth
393f922081
Merge pull request #8747 from ethereum/smt_chc_docs_internal_calls
Add internal function calls to CHC docs
2020-04-23 12:14:54 +02:00
chriseth
2ea2267179
Merge pull request #8735 from ethereum/bugs-url
Add missing blog URLs to bugs.json
2020-04-23 12:06:41 +02:00
chriseth
615668bfb4
Explain nonpayable
Fixes https://github.com/ethereum/solidity/issues/8736
2020-04-23 01:35:21 +02:00
Leonardo Alt
1cb68b1be7 Add internal function calls to CHC docs 2020-04-22 20:15:01 +02:00
Alex Beregszaszi
fe383fbd7a Add missing blog URLs to bugs.json 2020-04-22 12:03:10 +01:00
chriseth
8c60b2c847
Merge pull request #8714 from iamdefinitelyahuman/develop
Add dark mode to documentation
2020-04-20 21:36:17 +02:00