SciML / ADTypes.jl

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

Recent PR broke the API #56

Closed gdalle closed 4 months ago

gdalle commented 4 months ago

The recent PR #54 by @adrhill, which was merged by @ChrisRackauckas before I had time to review it, makes things disappear from the public API in a breaking way. In Julia, the documentation is the public API, so we cannot edit docstrings quite however we want.

The things that need to be done are:

Essentially, I'd prefer to revert the entire PR and then add back this precision everywhere:

Struct used to select the ... backend for automatic differentiation.
Exported from ADTypes.jl
adrhill commented 4 months ago

In Julia, the documentation is the public API, so we cannot edit docstrings quite however we want.

I understand the issue. #54 changed the documentation from "developer docs" to "user docs" and I didn't have this in mind. However, since ADTypes are user-facing, I would argue that we need both (see #31). So I think a full revert isn't a long-term solution either.

gdalle commented 4 months ago

That's why I said we can add back the user precision