<div dir="ltr">I've been thinking about inline documentation and documentation-in-REPL, and I came up with the following ideas:<div><br></div><div style>1. If there's some kind of unique per-compiled-function identifier that is consistent across runs, this can be used to look up documentation in an external file.  If a tool is made to scrape doc comments and produce this database, then there will be no runtime bloat if the documentation is never accessed.</div>
<div style>2. It doesn't seem to be a big deal to bloat interpreted functions, though making interpreted functions keep their documentation comments would require a kind of weird and non-trivial extension to the reader.  BUT, it would still be really cool.</div>
<div style>3. Python-style doc strings, _if_ the compiler knows to optimize them out, would be a simple solution and wouldn't require a strange reader.  e.g.</div><div style><br></div><div style>(define (map proc l)</div>
<div style>#<<END_OF_DOC</div><div style>(map proc l)</div><div style><br></div><div style>   Does such and such...</div><div style>END_OF_DOC</div><div style>  ...)</div><div style><br></div><div style>Thoughts?</div>
</div><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Jun 20, 2013 at 2:41 PM, Mikael <span dir="ltr"><<a href="mailto:mikael.rcv@gmail.com" target="_blank">mikael.rcv@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Just provide a very very clear format and structure for how this documentation should be committed into and represented in the repo, and I'm sure there's people who are happy to contribute.<div>
<br></div><div>What in the documentation can be cleaned up?<br>

<br><div class="gmail_quote">2013/6/20 Marc Feeley <span dir="ltr"><<a href="mailto:feeley@iro.umontreal.ca" target="_blank">feeley@iro.umontreal.ca</a>></span><br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">


<div><br>
On Jun 20, 2013, at 10:09 AM, Guillaume Cartier <<a href="mailto:gcartier@jazzscheme.org" target="_blank">gcartier@jazzscheme.org</a>> wrote:<br>
<br>
> There is also the 6.4 Undocumented extensions section in the Gambit manual that is there for this purpose, correct me if I'm wrong Marc.<br>
<br>
</div>In principle that section if for documenting the existence of procedures that don't have documentation.  I see that the first few are documented and should be moved elsewhere!  The documentation should be cleaned up.  Are there people out there with some free time and a generous nature?<br>



<span><font color="#888888"><br>
Marc<br>
</font></span><div><div><br>
_______________________________________________<br>
Gambit-list mailing list<br>
<a href="mailto:Gambit-list@iro.umontreal.ca" target="_blank">Gambit-list@iro.umontreal.ca</a><br>
<a href="https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list" target="_blank">https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list</a><br>
</div></div></blockquote></div><br></div>
<br>_______________________________________________<br>
Gambit-list mailing list<br>
<a href="mailto:Gambit-list@iro.umontreal.ca">Gambit-list@iro.umontreal.ca</a><br>
<a href="https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list" target="_blank">https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list</a><br>
<br></blockquote></div><br></div>