Jump to content
Sign in to follow this  

Automatic documentation creation?

Recommended Posts

Dear developers,


Opusmodus has a nice and rather extensive documentation. Nevertheless, I wondered why you use manually written rtf files for that.

As you most likely know, Common Lisp already supports facilities to add documentation to symbols (e.g., functions) themselves.

Example: try (documentation 'list 'function).


With such facilities some automatically generated documentation could be created (at least partly), which would at least avoids certain typos. I ran in only a few typos so far in the documentation, but they exist. Here is an example: In reference, the first argument of TONALITY-SERIES is root, but that is wrong, as documentation of function itself reveals.  
I understand that missing formatting of the documentation strings could be a problem. However, the doc string could use a syntax like markup, which could be automatically translated into a richer formatting with headlines etc.  
Of course, I do not expect you to switch the documentation system now any time soon, considering all the work that went into the manual documentation. I only wonder why you did not use the existing facilities provided by Lisp itself.



Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Sign in to follow this  

  • Similar Topics

    • By Andy
      I'm sure it's staring me in the face but I cannot find any info on the Live Coding Instrument apart from the videos Stephane made.
    • By hlcny
      The "Introduction to Opusmodus"  tutorial states that the 30 part stages collection of score-scripts and text commentaries..."is available for download as a pdf file formatted as a printable A4 book". But I have not been able to find the download...where can I find it? On a related note, and partly the reason for my wanting to get a pdf, is there any way to make the fonts larger in the Assistant pane? Thanks in advance for any info!
    • By JulioHerrlein
      Dear Friends,
      I'm working on a piano piece where each hand
       plays complementary rhythms.
      For example,
      If LH plays  (s -s s s -s) then
         RH plays  (-s s -s -s s)  accordingly whit the concept.
      Everything is parametric, each hand have a set of pitches, dynamics and articulations,
      so I did one OMN assembling for each hand, to have more control over the material.
      It ends like you can see in the code, below.
      Since all I have is just the complementary rhythms, I'd like to write it in a form of continuous sixtenth notes, in cross staff.
      So, the problem is that in Finale I have to manually do all this painful work, dragging notes up and down, to make cross staffing, because,
      the output in the XML gives me two independent voices. It's really boring to do.
      Is there some way to automatically generating this cross staff layout, with this architeture of coding, preserving the content
       of each hand ?  I use this kind of writing it a lot.
      Thanks for help !
      (setf pianoassemblerh (assemble-seq lhmat1)) ;;; Material for Left hand (setf pianoassemblelh (assemble-seq rhmat1b)) ;;; Material for Right hand ;;; SCORE (def-score Piano-1            (:key-signature 'atonal             ;:time-signature '((4 4 3) (4 4 1))             :time-signature '((3 4))            :tempo 80             :layout (piano-layout 'piano-rh 'piano-lh :all-accidentals t)) (piano-rh    :omn pianoassemblerh    :channel 1    :sound 'gm    :program 'acoustic-grand-piano)   (piano-lh    :omn pianoassemblelh    ))  
  • Create New...