This repository has been archived by the owner on Sep 9, 2020. It is now read-only.
Docstrings on variables in environments #177
Merged
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
jkarni
reviewed
Oct 30, 2018
src/Radicle/Internal/Effects.hs
Outdated
| [ ("print!", \case | ||
| [x] -> do | ||
| putStrS (renderPrettyDef x) | ||
| pure nil | ||
| xs -> throwErrorHere $ WrongNumberOfArgs "print!" 1 (length xs)) | ||
|
|
||
| , ( "doc!" | ||
| , oneArg' "actual-doc" $ \case |
There was a problem hiding this comment.
Why actual-doc and not doc?
There was a problem hiding this comment.
Just when I was developping, I didn't want to conflict with document (which I thought was called doc). Will fix.
jameshaydon
force-pushed
the
f/in-lang-doc
branch
from
1b69a2e
to
2610a20
Compare
jkarni
reviewed
Oct 30, 2018
| [ ("print!", \case | ||
| [x] -> do | ||
| putStrS (renderPrettyDef x) | ||
| pure nil | ||
| xs -> throwErrorHere $ WrongNumberOfArgs "print!" 1 (length xs)) | ||
|
|
||
| , ( "doc!" |
There was a problem hiding this comment.
This isn't actually impure, right? Is the idea that documentation raises questions about referential transparency?
There was a problem hiding this comment.
Well, it's as impure as print!.
There was a problem hiding this comment.
(It print's a formatted text to output, rather than return a string.)
jameshaydon
force-pushed
the
f/in-lang-doc
branch
3 times, most recently
from
f75eed8
to
874e3c9
Compare
|
@jkarni Replaced doc-objects with simple strings. |
jameshaydon
force-pushed
the
f/in-lang-doc
branch
2 times, most recently
from
0ef6a15
to
6439651
Compare
jkarni
reviewed
Oct 31, 2018
jkarni
reviewed
Oct 31, 2018
jkarni
reviewed
Oct 31, 2018
jameshaydon
force-pushed
the
f/in-lang-doc
branch
from
6439651
to
199f4c6
Compare
jkarni
reviewed
Oct 31, 2018
jkarni
reviewed
Oct 31, 2018
jkarni
reviewed
Oct 31, 2018
jkarni
reviewed
Oct 31, 2018
jkarni
approved these changes
Oct 31, 2018
|
@jameshaydon can you update the PR description to reflect the new design? |
jameshaydon
changed the title
This was referenced Oct 31, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds:
defspecial form which takes a documentation object.doc!primfn which prints the docs.apropos!primfn which prints docs for all variables in scope.Fixes #163.
Fixes #71.