Re: Csound Score Processing Python Module

I've spent much of my free time working on the first real documentation for the Score Processing Module:

http://www.thumbuki.com/csound/files/mailinglist/score0.0.1a_docs/index.html

I've learned a few lessons.  First, documentation is hard, and I have a new found respect for those who do it

Second, it's totally worth it.  By taking the time to start properly document this project, I'm not only more familiar with my own work, I have a much greater understanding of where I need to take it in the future.  This was two days well spent.

Question:  Has there ever been any discussion about incorporating docstrings into Csound?

Much of the existing Csound code-base is lacks in proper documentation.  This is something I'm personally guilty of.  If we are truly looking for ways to improve Csound, perhaps we should start encouraging coders to write better comments || implement something similar to Python docstrings.  Maybe for Csound6.  In the meantime, we can at least discuss potential guidelines.

Best,
Jake





I'm working under the principle of "release early, release often."  These first few releases are going to be a bit chaotic, as I'm still laying out the groundwork.  Mind you, I'm only two weeks into my Python education, and I'm still trying to figure out the pythonic way of doing things.

I assure you that one of my main priorities is to make this package as user-friendly as possible.  Based on your comments, I'm going to move documentation up on my list of priorities.  I've already begun looking into converting python doc strings into an HTML document.  Think I might have already found what I'm looking for.  This should part of the next release.

Best,
Jake

francibal wrote:

Dear Mr JJ,
many thanks for this. I use python and csound (but i'm just always beginner!), and, sorry, but i'm a little bit fussy, and i like to see a regular disposition in a work, a tidy page... When i study some csd from others people my first work is to order that with regular space and tab, thinking "ah, what confusion!". Yes, a little bit obsessing ...
Then i would like to thanks for Your works,

ciao,

fran.