[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation

From: Neil Jerram
Subject: Re: Documentation
Date: 26 Feb 2001 19:54:24 +0000
User-agent: Gnus/5.0808 (Gnus v5.8.8) Emacs/20.5

Thanks for your comments.  I'll reply in more detail later (tomorrow?)
but there are a couple of points that I don't follow at all and so
would appreciate further explanation...

>>>>> "Michael" == Michael Livshin <address@hidden> writes:

    Michael> Neil Jerram <address@hidden> writes:
    >> operation.  This is achieved by documenting a symbol value:
    >> (document! 'case-fold-search "...")

    Michael> the intention is to document a binding, right?  so the
    Michael> above will document the binding in the current module
    Michael> named by 'case-fold-search, and not the symbol
    Michael> 'case-fold-search?

Good point - I have no idea whether/how this would work.

    Michael> here's a mini-proposal:

    Michael> what do we really want when we say "documentation for
    Michael> module foo"?  I think we really are saying "documentation
    Michael> for all the bindings of module foo".

    Michael> so the natural (well, probably not, as it occured to me
    Michael> only now) thought is: let's use the module system.

    Michael> (define (snarf-docs module-name) (let ((module
    Michael> (resolve-module module-name))) (for-each-exported-binding
    Michael> (lambda (b) (filter-docs b)) module)))

This is the main thing that I don't get.  Could you explain a little
more?  Who and when would call `snarf-docs', and what would
`filter-docs' do in this proposal?

    >> Looking forward to your comments!

    Michael> be careful what you wish for. ;)

:-)  Best regards,


reply via email to

[Prev in Thread] Current Thread [Next in Thread]