Add Λnk README #1139
Merged
Add Λnk README #1139
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #1139 +/- ##
============================================
+ Coverage 42.75% 42.76% +<.01%
Complexity 813 813
============================================
Files 400 400
Lines 11005 11005
Branches 1256 1256
============================================
+ Hits 4705 4706 +1
Misses 5932 5932
+ Partials 368 367 -1
Continue to review full report at Codecov.
|
pakoito
approved these changes
Nov 19, 2018
|
Amazing job :D |
raulraja
reviewed
Nov 19, 2018
|
|
||
| ## Errors output | ||
|
|
||
| When something goes wrong Λnk shows what snippet has failed and where, including the compiler errors. |
There was a problem hiding this comment.
This should probably show an example with a snippet that fails and how ank reports it.
|
|
||
| ## Modifiers | ||
|
|
||
| By default Λnk compiles and evaluates the snippets of code included in `ank` sheds. However sometimes you might want a definition without printing the result out, or might want to replace an entire snippet with the output of the resulting evaluation. For these occasions Λnk provides a number of modifiers that you can add to the shed declaration. |
There was a problem hiding this comment.
I would use ````kotlin:ank:*fences instead of justank`
|
|
||
| | Modifier | Explanation | | ||
| |---|---| | ||
| | `:silent` | Suppresses output; under this modifier the input and output text are identical. | |
There was a problem hiding this comment.
We should provide an example for each one of these.
This was referenced Dec 13, 2018
Merged
Closed
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.
README