Re: request for feedback: pyfmf

From: Dan Perl (danperl_at_rogers.com)
Date: 10/27/04 

Date: Wed, 27 Oct 2004 09:02:29 -0400

Thanks, Michael. It would be easy to add a directory to the packages with
all the documentation I have on the web site. Now, the question is: is that
documentation good enough? My personal experience with using open-source
projects has been that they are very poor in documentation. I don't want to
do the same with my project, but I did make the decision to rather put out a
release quickly, even if the documentation is on the thin side. Having said
that, I hope that what I already have (on the web) is good enough to get
someone started.

I will put out two minor releases that will include the documentation, but
until then, any feedback on the documentation that is on the web?

Thanks again,

Dan

"Michael Foord" <fuzzyman@gmail.com> wrote in message
news:6f402501.0410270426.5d83bf0c@posting.google.com...
> "Dan Perl" <danperl@rogers.com> wrote in message
> news:<oOGdnVv0D8jmduPcRVn-gg@rogers.com>...
>> pyfmf is a project I started a few months ago and that is registered with
>> sourceforge (http://pyfmf.sourceforge.net,
>> http://sourceforge.net/projects/pyfmf). It consists of a framework for
>> file
>> management, with a console based toolkit (zigo) and a graphical platform
>> (zago) based on the framework. Both zigo and zago are still alpha
>> releases,
>> addressed only to python enthusiasts.
>>
>> I just released a new version of zigo and the first release of zago.
>> There
>> have been a few tens of downloads of previous releases of zigo (which is
>> not
>> bad) but I never received any feedback (at least I didn't get any bad
>> feedback either). I would like to hear what other people think about it.
>> I
>> am interested in comments on uses, design, coding or just simply whether
>> you
>> think this is interesting and useful. Please take a look at the home
>> page
>> of the project: http://pyfmf.sourceforge.net.
>>
>
> Another suggestion not so minor really - bundle docs *with* the
> downloads, or as a minimum offer a separately packaged bundle of docs
> for offline reading...... I've seen some amazingly useful looking
> modules that I've never bothered to wade through the source code of to
> work out what they actually do. Asa simple rule it's about ten times
> easier to write your own code than it is to read someone else's. It's
> an extremely useful skill to gain - but not one you can rely on people
> practising on your code !! Sorry, bit of a rant - but it really annoys
> me when I download a useful looking bit of code, take it home and
> unpack it - only to discover there's no docs bundled with it....
> *sigh* If it's woorth writing, it's worth documenting...
>
> Regards,
>
>
> Fuzzy
> http://www.voidspace.org.uk/atlantibots/pythonutils.html
>
>> Thanks,
>>
>> Dan Perl

Relevant Pages

  • Re: Where is the definition or documentation of PDF "default user space units"?
    ... documentation, I found very terse mention of "default user space ... all my perl scripts that make PDF files use ... about use of PDF::API2, and related packages, than it is about the PDF ... you can scale the coordinate system to inches ...
    (comp.lang.perl.misc)
  • Re: Request for comments on simple Ada program
    ... What I still do put in the source code - and don't like putting there - is the abstracts for the subprograms and packages. ... But how can I easily cross-link the documentation and the code? ... The conversation seems to be drifting towards Knuth's "literate programming". ...
    (comp.lang.ada)
  • Re: Where is the definition or documentation of PDF "default user space units"?
    ... I found very terse mention of "default user space ... about use of PDF::API2, and related packages, than it is about the PDF ... What was written in the documentation I referred to does ... functions and packages provided to create and edit PDF files. ...
    (comp.lang.perl.misc)
  • Re: expl3, xpackages, mhtools and order (tikz, pst-3d)
    ... using TeXLive...so that means my latex has etex extensions enabled (no ... breqn must be loaded AFTER empheq ... Ordinarily I'd suggest contacting the authors but here the principle author of the mh packages is also somewhat involved in expl3 and xpackages. ... Both cases 2) and 3) are dealt with on the very first page of the breqn documentation. ...
    (comp.text.tex)
  • Re: Plain TeX and long tables
    ... >> there's far less tutorial information available for plain users than ... >> authors deign to describe their packages, other than in the odd remark ... the reason why cataloguing of much of ctan is proceeding so slowly. ... documentation. ...
    (comp.text.tex)