search

ferella / polepp

Automatically exported from code.google.com/p/polepp
0 stars 0 forks source link

Documentation is split between doxygen and README #3

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago 
It would be nice if the documentation of the tools were available from the 
doxygen html page, which explains the statistical method used.

As a newcomer I find it hard to understand what tools are available and what 
they do.
E.g. the doxygen html page lists (but doesn't describe) four tools:
polelim
polecov
polebelt
poleconst

The README explains two tools: polelim, polecov

Actually there are six tools:
$ ls -1 tools
polebelt
polecomb
poleconst
polecov
polelim
polepow

But only polelim and polecov are build by default.

What do the other tools do? Are they only for internal debugging or useful for 
users?

Original issue reported on code.google.com by Deil.Chr...@googlemail.com on 1 Jul 2011 at 3:52

GoogleCodeExporter commented 8 years ago 
I'm sorry about the confusion - I have not had the time to cleanup and make the 
docs consistent.
The other tools you mention were used for a coverage study.
I removed them from the make since they had some problems.
This (tools and docs) should be fixed but I'm not sure when I can do it since I 
do not work in HEP anymore.
I will make an assessement on what needs to be done and try to find time to do 
that.

Original comment by teg...@gmail.com on 4 Jul 2011 at 7:44

GoogleCodeExporter commented 8 years ago

Original comment by teg...@gmail.com on 5 Jul 2011 at 7:04