Readability improvements and additional code examples for the Solidity docs #399
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 5 commits
February 18, 2016 10:27
|
This is great, thanks a lot! One tiny suggestion: Could you put links to the sections that explain the respective contract-level element in more detail? |
|
Could you give an example? Just "name-spacing" the links, e.g. |
|
I mean directly linking to e.g. here: https://solidity.readthedocs.org/en/latest/contracts.html#function-modifiers |
added 4 commits
February 19, 2016 11:03
…stency with existing naming
…ion and function modifier overview in the structure section
…h the globally probably more used in-depth links
|
Ok, so far for now. Feel free to change everything you are not satisfied with yet. Cheers and a nice weekend |
|
Perfect, thanks! |
chriseth
added a commit
that referenced
this pull request
Feb 19, 2016
Readability improvements and additional code examples for the Solidity docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I worked a bit on the Solidity documentation. I added some code blocks for import syntax explanations and the compiler use section and also extracted example code snippets from the example section to illustrate the structure elements in the
Structuresection.The changed documentation compiles with the
make htmlcommand without additional errors.Cheers
Holger