cps: implement shims for docgen #331
Open
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
Contributor
Author
|
How the
|
Currently CPS simply left the procedures untouched during docgen. This
causes problems when code for `whelp` gets sem-ed, breaking docgen.
This commit implements a couple docgen shims:
- `cps` now result in a `{.cps: baseType.}` pragma tagged to the
resulting procedure and will show up in the generated documentation.
- `whelp` will generate `nil` continuation for the base type of a cps
proc.
- `whelp` will generate a `Callback` with a factory type that yields a
the base continuation type, not the environment type. This should work
for most cases when docgen are concerned.
This worked well enough for `insideout` docs to be generated
successfully under NimSkull.
alaviss
force-pushed
the
push-oxwpmnxzxlvy
branch
from
2098700 to
2aaae6a
Compare
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.
Currently CPS simply left the procedures untouched during docgen. This causes problems when code for
whelpgets sem-ed, breaking docgen.This commit implements a couple docgen shims:
cpsnow result in a{.cps: baseType.}pragma tagged to the resulting procedure and will show up in the generated documentation.whelpwill generatenilcontinuation for the base type of a cps proc. Parameters that are supposed to go on the bootstrap are added usinglet {.used.}, which should allow their effects to be reflected in the generated docs.whelpwill generate aCallbackwith a factory type that yields a the base continuation type, not the environment type. This should work for most cases when docgen are concerned.This worked well enough for
insideoutdocs to be generated successfully under NimSkull.