ashinn / chibi-scheme

Official chibi-scheme repository
Other
1.22k stars 141 forks source link

chibi-doc sort fails #177

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?
:
$ chibi-doc sort
ERROR in %module-exports on line 11 of file /usr/local/share/chibi/meta.scm: 
vector-ref: not a vector: #f

What is the expected output? What do you see instead?

Some documentation, no error.

What version of the product are you using? On what operating system?

chibi-scheme 0.6.1 "carbon" (chibi r7rs ratios complex threads full-unicode 
modules dynamic-loading bsd macosx little-endian)

Original issue reported on code.google.com by d.thei...@objectpark.org on 29 May 2013 at 2:16

GoogleCodeExporter commented 9 years ago
This is actually a tool for processing files/modules, so "chibi-doc 
<identifier>"
doesn't work.  "chibi-doc srfi.95" or "chibi-doc lib/srfi/95.sld" will work, but
that module currently doesn't have useful docs.

However, the error is confusing - I'll fix it to say something like "no module
or file matching (sort) found".

Original comment by alexsh...@gmail.com on 29 May 2013 at 2:20

GoogleCodeExporter commented 9 years ago
Thanks for clarification and for providing a nice error message for newbies 
like me.

Original comment by d.thei...@objectpark.org on 29 May 2013 at 2:27

GoogleCodeExporter commented 9 years ago
Aside from my confusion: Is there a function that displays the documentation 
for a given function name? Is this information available at all?

Original comment by d.thei...@objectpark.org on 29 May 2013 at 2:32

GoogleCodeExporter commented 9 years ago
Not conveniently, but there should be.  I'll add this.

Original comment by alexsh...@gmail.com on 29 May 2013 at 2:38

GoogleCodeExporter commented 9 years ago
This issue was closed by revision f9194a843fe8.

Original comment by alexsh...@gmail.com on 29 May 2013 at 2:49

GoogleCodeExporter commented 9 years ago
Thanks, Alex for reacting so quickly!

Original comment by d.thei...@objectpark.org on 29 May 2013 at 3:19

GoogleCodeExporter commented 9 years ago
FYI, in the latest head you can now use:

  chibi-doc <module> <binding>

to print just the docs for the given binding.

Also in the (chibi repl) repl you can do:

  @help <binding> [<module>]

to do the same (if the binding is an imported
procedure you don't need to specify the module).

Both of these are limited by the fact that
the documentation is incomplete.

Original comment by alexsh...@gmail.com on 3 Jun 2013 at 8:52