Fwd: UIOP documentation?
fahree at gmail.com
Wed May 6 06:46:06 UTC 2015
[I got notification on the below message being rejected because the
quickdocs url is blacklisted by http://lookup.uribl.com/ !? I stripped
said url so the message makes it to the list.]
On Tue, May 5, 2015 at 8:35 PM, Robert P. Goldman <rpgoldman at sift.net> wrote:
> Faré wrote:
>> UIOP has no manual, but it has a README.md which guides you through
>> the code and links to a website with interactive help as extracted
>> from docstrings. I included a direct link on the ASDF webpage in
>> doc/index.html — but only the maintainer has the rights to update the
>> actual webpage.
> I looked at the link to the version that's supposed to have good docs:
> AFAICT it shows only the docs for BACKWARD-INTERFACE, and maybe not even
> all of those.
Oh! It has more documentation than that, but depending on your screen
resolution, it can be totally unobvious that you can scroll the
package pane. Le sigh. I tried to document that in the uiop/README.md,
but that needs also be told in the index.html.
> As you report, the quickdocs page, http://....org/uiop/api, only
> provides docs for UIOP/PACKAGE.
> Also, for some reason these aren't clickable links in the README.md:
> they come through as preformatted text, instead.
OK, I was assuming ReST-style magic. I pushed a fix to that. Actually,
I made a few passes over both README.md and uiop/README.md.
I also merged into the minimakefile branch.
—♯ƒ • François-René ÐVB Rideau •Reflection&Cybernethics• http://fare.tunes.org
An anarchist is a man who is careful to always use pedestrian crossings,
because he utterly detests talking with policemen. — Georges Brassens
More information about the asdf-devel