georgebv / pyextremes

Extreme Value Analysis (EVA) in Python
https://georgebv.github.io/pyextremes/
MIT License
240 stars 47 forks source link

Add API description #24

Closed wiz21b closed 1 year ago

wiz21b commented 2 years ago

Unless I'm mistaken, there's no API published. It makes exploring the package difficult. For example, it was not obvious to me where to find the fitted distribution's parameters. I had to look at your code to find out :-) (fortunately, it's very well written so it wasn't hard :-) )

georgebv commented 2 years ago

I have (incomplete) documentation for the library here: https://georgebv.github.io/pyextremes/. There is no API reference; however, each function/class has docstrings (numpy format). If you would like to take a stab at generating API reference using those I would gladly accept that contribution and give you full credit. Currently I don't have much time myself to take on something like this, unfortunately.