I wouldn't associate having to use `Lwt_main.run` with “a limited background in programming”, but maybe that's just me.
beckford 7 hours ago [-]
I usually structure teaching the same way done in https://www.writethedocs.org/videos/eu/2017/the-four-kinds-o.... So "the Quick Walkthrough Guide will explain what dk scripts are and give you small examples to run" is simply a learning-oriented tutorial which is mostly about giving students confidence and visual feedback. And simultaneously it an explanation of nothing (the video has a great explanation for why to do that). So, I agree that an explanation of threads + Internet + cross-compilation would quite nuts, but for an experienced developer I'd expect to see a meaty example (take a look at https://ziglang.org/ for comparison).
One concrete action may be to make two distinct Quick Start guides ... one for the experienced and one for the inexperienced students though. Is that your thinking?
filoleg 3 hours ago [-]
You are totally fine, the grandparent comment is just either needlessly nitpicking (“great is the enemy of the perfect”) or misunderstanding what the tool is supposed to be used for.
P.S. Your idea of having two distinct quick start guides (one that goes into the meaty details and another one that is just “run this command and you are good to go”) is great. But imo it is not necessary/crucial, and not having it doesn’t detract from the value proposition of your tool at all either.
rfl890 2 hours ago [-]
I'm very confused at first glance. What are "coder scripts"? Why is "std" repeated 3 times in "dk StdStd_Std.Run"? What on earth is "Tr1Stdlib_V414Io"? The entire tool comes off as arbitrary and confusing, at least to me. I would really quite appreciate a brief primer on the language and its design decisions, architecture and syntax. So far, I'm just having assorted bits of information thrown at me with no real structure.
(Note: I have never touched OCaml. Is this some weird OCaml thing?)
beckford 19 minutes ago [-]
It is the OCaml language but it also isn't packaged like conventional OCaml. Please don't blame OCaml for that.
It _does_ need a primer for those unfamiliar with OCaml. I was thinking ... since this is scripting ... part of it will probably take the form of a cheat sheet for people coming from Java/C#, JavaScript and Python backgrounds. And another part of it would be how to read an OCaml expression from left to right. Other suggestions welcome.
Direct answers:
- the full explanation of why Std is repeated three times is covered over the first four sections of the first manpage "dk(1)": <https://diskuv.com/dk/help/latest/manual/dk-1/>. It will go over some of the design behind that and also introduce aliases so that "the tool `StdStd_Std.Run` can be typed as `Run`". Did I unnecessarily expose "StdStd_Std" in the introduction?
- the `Tr1Stdlib_V414Io` is a library described in the first reference manual "dkcoder-libraries(7)": <https://diskuv.com/dk/help/latest/manual/dkcoder-libraries-7...>. Aside: Clicking through that will eventually lead to a broken link. I'll fix that shortly.
One concrete action may be to make two distinct Quick Start guides ... one for the experienced and one for the inexperienced students though. Is that your thinking?
P.S. Your idea of having two distinct quick start guides (one that goes into the meaty details and another one that is just “run this command and you are good to go”) is great. But imo it is not necessary/crucial, and not having it doesn’t detract from the value proposition of your tool at all either.
(Note: I have never touched OCaml. Is this some weird OCaml thing?)
It _does_ need a primer for those unfamiliar with OCaml. I was thinking ... since this is scripting ... part of it will probably take the form of a cheat sheet for people coming from Java/C#, JavaScript and Python backgrounds. And another part of it would be how to read an OCaml expression from left to right. Other suggestions welcome.
Direct answers:
- the full explanation of why Std is repeated three times is covered over the first four sections of the first manpage "dk(1)": <https://diskuv.com/dk/help/latest/manual/dk-1/>. It will go over some of the design behind that and also introduce aliases so that "the tool `StdStd_Std.Run` can be typed as `Run`". Did I unnecessarily expose "StdStd_Std" in the introduction?
- the `Tr1Stdlib_V414Io` is a library described in the first reference manual "dkcoder-libraries(7)": <https://diskuv.com/dk/help/latest/manual/dkcoder-libraries-7...>. Aside: Clicking through that will eventually lead to a broken link. I'll fix that shortly.