ostap icon indicating copy to clipboard operation
ostap copied to clipboard

Missing manual or even a hint of overview.

Open jaromrax opened this issue 5 months ago • 1 comments

Ok if you want to keep the project private, but if not, at least an example of what ostap does would make a change. Jar

jaromrax avatar Jul 09 '25 07:07 jaromrax

Dear @jaromrax

Thank you for your comment!

I can only agree with you that unfortunately there is a lack of global documentation. There are two versions of tutorials (one is completely obsolete and another is almost completely obsolete). The updated tutorials are in the pipeline, but it takes some time.

I'd like to point that there are many (~380) tests oscattered in the tests-subdirectories: ostap/*/tests/test_*.py These tests could be considered as a kind of "examples". Surely they do not replace the proper documentation but they represent a rather extensive set of "examples".

(Also, almost all methods/functions are documeted in the code, that is partly helpful)

VanyaBelyaev avatar Jul 09 '25 13:07 VanyaBelyaev