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

Generate documentation for traversal, mutation and filter methods #22

Open
fkling opened this issue Jul 23, 2015 · 3 comments
Open

Generate documentation for traversal, mutation and filter methods #22

fkling opened this issue Jul 23, 2015 · 3 comments

Comments

@fkling
Copy link
Contributor

fkling commented Jul 23, 2015

To know which methods are available, one has to to look at the source code. It would be cool if we could organize the method definitions in such a way that it makes it easy to auto generate documentation from the source.

@juliankrispel
Copy link

That would be very nice indeed!

@DrewML
Copy link
Contributor

DrewML commented Jul 4, 2016

@fkling did you have any ideas for what kind of tooling you'd like to use to accomplish this? I think this would go a long way towards lowering the barrier to entry.

The method I've seen used most frequently is JSDoc comments. I think the problem there, though, is that you either need to be super strict about keeping the comments up to date, or have linting rules in place to try and catch things like undocumented or re-ordered arguments.

@DrewML
Copy link
Contributor

DrewML commented Sep 5, 2016

Submitted a start on this work in #146.

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

No branches or pull requests

3 participants