Thanks for the feedback. I haven't used scribble before, but I'll look into it. Do you feel that it would be helpful to add scribble documentation for the magic language itself, or are you just referring to the API provided by #lang magic modules?
For the language itself, I can see documentation being helpful if I can keep it up to date with the functionality currently supported by #lang magic. I'll also need to check on how the magic man pages are licensed. It would save a lot of time if I could copy from there as needed. Otherwise it will be a lot of work. The long term goal is to be able to slap a #lang magic on top of any magic file taken from the file command's repository and it will just work. At that point #lang magic will effectively be able to share the excellent documentation provided by the file command. Of course, another goal is to add enhancements that don't break compatibility. I'll also do some more work to improve the github README as you suggested. Thanks for your input! -- Jonathan On Thursday, August 1, 2019 at 1:07:36 AM UTC-4, Neil Van Dyke wrote: > > Jonathan Simpson wrote on 7/31/19 9:54 PM: > > #lang magic is my implementation of the mini language used by the Unix > > file command. > > Nice. In addition to the practical merits, and the craft, it's also an > example of a useful legacy DSL we can point to (like lex, yacc, make), > and which Racket now implements. > > You might want to make API documentation for it in Scribble. (Your > racket-users post contains helpful information that's not currently with > the code in GitHub. Also, we're currently having trouble with > racket-users Google Groups often inexplicably not showing up in Google > searches, which is yet another reason to try to consolidate > documentation with the code in a simple way.) > > Besides API documentation helping others to use some code, as well as > establishing an API of *what* as distinct from *how*... the > documentation is also a well-deserved chance to show off your work in > different way than the code itself, and with Scribble slickness. Or > Markdown. > > -- You received this message because you are subscribed to the Google Groups "Racket Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to racket-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/racket-users/2f60e998-99d7-424b-a3ae-28f78149430a%40googlegroups.com.
