Document JSON I/O error classes#3068
Document JSON I/O error classes#3068axic merged 1 commit intoargotorg:developfrom izgzhen:document-io-class
Conversation
|
@axic Still WIP, but you may comment the first few examples at any time |
|
That seems to be a good location for it. You could add a comment in the output example next to |
|
Finally grabbed sometime to finish the rest error names that I can find :) |
docs/using-the-compiler.rst
Outdated
| 3. ``InternalCompilerError``: internal compiler error, e.g. compilation failed, JSON logic error, JSON runtime error etc. | ||
| 4. ``Exception``: Unknown exception during compilation | ||
| 5. ``UnimplementedFeatureError``: some feature is not implemented | ||
| 6. ``Exception``: Exception during compilation |
docs/using-the-compiler.rst
Outdated
|
|
||
| 1. ``JSONError``: JSON input doesn't conform to the required format, e.g. input is not a JSON object, the language is not supported etc. | ||
| 2. ``IOError``: Input/Output errors, e.g. invalid URLs | ||
| 3. ``InternalCompilerError``: internal compiler error, e.g. compilation failed, JSON logic error, JSON runtime error etc. |
There was a problem hiding this comment.
JSON errors are not reported as part of this.
There was a problem hiding this comment.
the information comes from code:
./libsolidity/interface/StandardCompiler.cpp:457: return formatFatalError("InternalCompilerError", string("JSON logic exception: ") + _exception.what());
./libsolidity/interface/StandardCompiler.cpp:461: return formatFatalError("InternalCompilerError", string("JSON runtime exception: ") + _exception.what());
There was a problem hiding this comment.
Ah ok, those messages are a bit misleading. It still means that the compiler code is broken, not that the supplied data is broken.
All it should say is something like "internal bug in the compiler (should be reported as an issue)".
There was a problem hiding this comment.
I see, thanks a lot
|
These are missing:
|
pirapira
left a comment
pirapira
left a comment
There was a problem hiding this comment.
Please fix
/home/travis/build/ethereum/solidity/docs/using-the-compiler.rst:290: WARNING: Enumerated list ends without a blank line; unexpected unindent.
in the Travis build.
|
updated, thanks! |
|
Added warnings and updated the descriptions. |
|
The test failure was only a truffle issue. Merging this as the documentation test passed. |
3 participants
Issue #2186