This is the mail archive of the guile@cygnus.com mailing list for the guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: primitive documentation conventions



 In order to update the XEmacs lispref.info, they run a processor over
 the source files, and it extracts the docstrings into a big texi
 file, with ready-to-paste-in function and variable definitions.
 Then, they've got to go through the manual's texi source, find the
 places where function docstrings have been changed during the course
 of development, and paste the new definitions into place.

 It would be really cool if instead, they could write a tag there that
 told the info reader to pull up the docstring for that function or
 variable, and insert it here.  That could be made to work for printed 
 output also, I guess.

 The main idea is to reduce the maintenence work you have to do.  If
 you change a function's call signature, and update its docstring,
 that should be all you need to do to have the live documentation also 
 be updated, and a make target ought to then rebuild the more static
 version of the docs.

 I really like Windows help... the features it has that I like are the 
 popup glossary entries, and the nice fonts they use.  Another neat
 thing is the ability to embed widgets and pictures.  We need that for 
 Emacs/XEmacs/Guild/Gimp/SCWM.