A bit of everything related to v0.3 #80
Conversation
|
The implementation is done now. Opinions are welcome. I will add a few tests tomorrow :) |
|
Hmm I don't think I can see the change request 🤔 |
src/nimib/blocks.nim
Outdated
| @@ -16,15 +16,16 @@ func nbNormalize*(text: string): string = | |||
| text.replace("\c\l", "\n").replace("\c", "\n").strip # this could be made more efficient | |||
| # note that: '\c' == '\r' and '\l' == '\n' | |||
|
|
|||
| template newNbBlock*(cmd: string, nbDoc, nbBlock, body, blockImpl: untyped) = | |||
| template newNbBlock*(cmd: string, nbDoc, nbBlock, readCode, body, blockImpl: untyped) = | |||
There was a problem hiding this comment.
readCode should be bool and we could position it after cmd: string. We probably could also add the same old api where readCode is defaulted to true (not sure if template composition runs into issues there...)
There was a problem hiding this comment.
Moving it to the front sounds good 👍 I'm a bit afraid of adding types to templates now after battling with them yesterday. (saw that you had also come across this) but as you already have a string there it should be fine. Do you mean to default it as a readCode: bool = true or making a separate overload without it that just calls this new one? That's also something I battled with yesterday as optional parameters aren't supported in templates with untyped arguments without the experimental pragma. So the separate overload is really the only option. (if template composition behaves as we want it to as you said 🤣)
There was a problem hiding this comment.
Yep separate overload. I also had issues with optional arguments in templates.
There was a problem hiding this comment.
I'll give it a try after lunch. Feels good to have a test suite in nimib to rely on with these things now :)
There was a problem hiding this comment.
Yes that is another boone of recent PR... next step should be automatic generation of documentation with netlify/vercel preview as in scinim/getting-started
There was a problem hiding this comment.
Yes that is pretty neat! Do you prefer nbCode, nbText etc to use the variant with or without the explicit readCode parameter?
There was a problem hiding this comment.
Yes please to which one of them? 😅 Old or new?
weird, cannot find it either. Added it as a single comment |
Forgot to "add" it perhaps? Have happened to me before that I write a comment and then click the "Review Changes" button without actually "adding" the comment. |
fixes #85 (last step before tagging and releasing) - improve changelog - make sure all important changes (recent and older) are documented details: - [x] improving changelog and integrating thanks in changelog - [x] 0.1 - [x] 0.1.x - [x] 0.2 - [x] 0.2.x - [x] 0.3 - [x] move changelog to separate file - [x] improve documentation for some of the recent changes (from 0.2.0 until now) - [x] stuff in 0.2.0 that went un(der)documented - [x] add list of command line options generated with `nbInit` - [x] changes in 0.2.x - [x] 0.2.2: nbFile - [x] other 0.3 improvements by Hugo #80 - [x] nbRawOutput - [x] nbClearOutput - [x] release 0.3 stuff #81 - [x] newNbCodeBlock - [x] newNbSlimBlock - [x] new nbTextWithCode that does read code - [x] example files.nim for File - [x] nbPython # 83 - [x] nbInitPython and nbPython - [x] nim to javascript #88 - added a section - [x] nbCodeToJs (or by pieces nbInitToJs, addCodeToJs, addToDocAsJs) - [x] nbKaraxCode - [x] CodeAsInSource now the default: - [x] remove bullet point in API section - [x] add section "Code Capture" - [x] make sure to rerun nimble readme to have readme updated (currently missing the interactivity docs) - [x] other changes - [x] turned off warning for unused imports in `nimib.nim` (#103) - [x] fix md output of index.nim (bug in markdown backend?) - some other improvements that could be done later: #110
Creating this now so I don't forget some parts.
TODO:
mustacheimportreadCodeparameter tonbNewBlock