search

SciML / LinearSolve.jl

LinearSolve.jl: High-Performance Unified Interface for Linear Solvers in Julia. Easily switch between factorization and Krylov methods, add preconditioners, and all in one interface.
https://docs.sciml.ai/LinearSolve/stable/
Other
248 stars 53 forks source link

`cache.isfresh` can be a confusing name #363

Open gaurav-arya opened 1 year ago

gaurav-arya commented 1 year ago

It seems like cache.isfresh is used to check if the cache is out of date, e.g. in the docs: https://github.com/SciML/LinearSolve.jl/blob/3881230cf34d6a0414e8ca12de1280d00f5a0e8b/docs/src/advanced/developing.md?plain=1#L25-L33

But I think a fresh cache usually refers to one whose contents are up-to-date, while the above is actually checking for a "stale" cache. 🙃

(I guess the intention of the original name is that the new A is a "fresh" A, but it could be confusing if it were read as "is fresh cache" like I did, which means the exact opposite)

gaurav-arya commented 1 year ago

A couple renamings could be cache.isstale and cache.isfreshA. Perhaps the latter would be a smoother deprecation path

ChrisRackauckas commented 1 year ago

Yeah it means if A is fresh, but 🤷 I see what you mean.