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

`Node` is not visible in the docs #91

Open
jDomantas opened this Issue Feb 1, 2019 · 0 comments

Comments

1 participant
@jDomantas
Copy link

jDomantas commented Feb 1, 2019

Currently the module structure has some pieces that look somewhat like this (type parameters and fields removed for brevity):

mod arena_tree {
    pub struct Node;
}

pub mod nodes {
    pub type AstNode = crate::arena_tree::Node;
}

This means that Node gets exported publicly through comrak::nodes::AstNode, but does not have a documentation page itself (because there is no public item that corresponds to it), so you cannot see what functions it has in the docs. This gets even more confusing as calling functions like Node::traverse produces types that are not even mentioned in the docs, not even behind type aliases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment