Expand docstrings #30
Conversation
mcabbott
force-pushed
the
docstrings
branch
2 times, most recently
from
9cfd04f to
6a28efe
Compare
| By default, traverses `x` recursively using [`functor`](@ref) | ||
| and transforms every leaf node identified by `exclude` with `f`. |
There was a problem hiding this comment.
It's important to know that exclude is used before functor, it stops the recursion, rather than just controlling whether f is applied. I'm not sure that's what we want, but it's what we have.
There was a problem hiding this comment.
Yes, this is deliberate because it's the easiest way to control the depth of recursion. Looking back on #13, I think it might've been better just to call this isleaf: that's literally what it's checking and exclude could imply that f is not being applied to anything the function predicate says is true.
There was a problem hiding this comment.
Ok. Maybe all names for such things are confusing...
What it sounds like it might do is let you tell fmap(sqrt, (2, Foo(3, sin))) which leaves to apply f to, and which to leave alone, without altering recursion. I guess you can test isleaf first. Maybe all functionality can be written in terms of any other...
There was a problem hiding this comment.
It's a little confusing because f is also used as a name for not the original user callback, but in essence Functors will try to recurse into anything "left alone" by isleaf/exclude. It's just that the fallback definition of functor returns an empty tuple of children, so recursion naturally stops if the value in question can't be unpacked.
This adds more examples to show what this package actually does. Mostly examples, but I fixed the words where I thought them ambiguous, added something about
===etc.Should have no functional changes.
Documenter will run doctests when you do
] test, not only when building docs.