JuliaDynamics / PeriodicOrbits.jl

Interface and algorithms for finding periodic orbits (stable or unstable) in dynamical systems
https://juliadynamics.github.io/PeriodicOrbits.jl/
Other
8 stars 2 forks source link

API Documentation #15

Closed JonasKoziorek closed 6 days ago

JonasKoziorek commented 1 week ago

I have added docstrings of the API functions to the documentation. I read through the docstrings again and corrected some mistakes. I have not structured the documentation in some systematic way so far. I think Examples or Introduction page might be needed to introduce the user to the API.