Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

broken docs #70

Open
CarloLucibello opened this issue Feb 23, 2021 · 2 comments
Open

broken docs #70

CarloLucibello opened this issue Feb 23, 2021 · 2 comments

Comments

@CarloLucibello
Copy link

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

@jlumpe
Copy link
Collaborator

jlumpe commented Feb 24, 2021

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.

@plut
Copy link

plut commented Mar 9, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants