AbstractTrees.jl icon indicating copy to clipboard operation
AbstractTrees.jl copied to clipboard

Published 20 hours ago • verified publisher icon JuliaCollections

broken docs

Open CarloLucibello opened this issue 4 years ago • 2 comments

Most docs appear to be broken https://juliacollections.github.io/AbstractTrees.jl/dev/api/

CarloLucibello avatar Feb 23 '21 16:02 CarloLucibello

This is actually less being broken than just the docstrings for these functions not existing. I added those functions to the API page to highlight the issue, but so far they have not been added.

jlumpe avatar Feb 24 '21 16:02 jlumpe

In addition to this: may I suggest that the doc include a couple of paragraphs about “how to define your own tree type (indexed vs. struct-like)”? I know that there are examples, but 1) they are not too easy to read (being split among multiple files), 2)they do not really cover the whole API (e.g. the filesystem case seems to rely on generic methods?) and 3) I don't see an indexed tree example in them.

plut avatar Mar 09 '21 23:03 plut