jump-dev / MutableArithmetics.jl

Interface for arithmetics on mutable types in Julia
Mozilla Public License 2.0
49 stars 8 forks source link

Documentation is generally missing #286

Closed kalmarek closed 1 month ago

kalmarek commented 4 months ago

And the remaining one (in README) can be in subtle ways not exactly correct:

README says

The MA.operate!!(op::Function, x, args...) redirects to op(x, args...) if x is not mutable or if the result of the operation cannot be stored in x. Otherwise, it redirects to MA.operate!(op, x, args...).

but actually it redirects only to MA.operate(op, x, args...).

As for the future I'd be great if a tutorial page on implementing e.g. MA for Rationals is provided

odow commented 1 month ago

Closing in favor of https://github.com/jump-dev/MutableArithmetics.jl/issues/293