SciML / ADTypes.jl

Repository for automatic differentiation backend types
https://sciml.github.io/ADTypes.jl/
MIT License
36 stars 11 forks source link

Add docstrings and list of exports #23

Closed gdalle closed 4 months ago

gdalle commented 4 months ago

Checklist

Additional context

I'm not sure whether the lack of documentation is a bug or a feature. This is a pretty young and experimental package, so arguably we don't want to expose too much of the internals.

On the other hand it already has 18 registered direct dependents and 492 indirect ones. I would assume those dependents use "the code as the documentation", which means everything is API by default. This PR makes the API more explicit and discoverable.