Re: [Tcllib-devel] Graphops - Documentation (fwd)

[Andreas K. <aku...@sh...>]

> Hello.
 
> All local searching is done - just got one problem how to arrange
> one step of algorithm. If it takes too much time, I will describe it
> to you, maybe you will come up with some better solution.

I'll have a look.

> I have started with documentation work. So, some questions about it:

> - as it was described in developer file, I'm going to edit 'man'
>   file, from which is created html file during installation. Is
>   there anything else to do?

No, not really.

> - should there be any documentation file summarizing whole project?

What do you envision as its content ?

> - the documentation for graphops contains short descriptions on what
>   procedure does and how to use it. How about info concerning
>   complexities and generally some graph theory info about particular
>   algorithm? Or we assume that user knows, what he is looking for
>   when he wants to use e.g.  Christofides Algorithm?

The basic descriptions are a must. Having complexities would be good
as well. For theory we should have at least references to wikipedia or
other websites. If we have enough time left we can certainly add more.

-- 
So long,
	Andreas Kupries <aku...@sh...>
			<http://www.purl.org/NET/akupries/>
	Developer @	<http://www.activestate.com/>
-------------------------------------------------------------------------------