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

Documentation needs more fleshing out #278

Open
andrewcmyers opened this issue Jul 25, 2018 · 1 comment
Open

Documentation needs more fleshing out #278

andrewcmyers opened this issue Jul 25, 2018 · 1 comment

Comments

@andrewcmyers
Copy link
Collaborator

The existing documentation is helpful, but having done some hacking on the system, I can see that there are many things that ought to be described in more detail, such as the relationship between expression nodes and projections and how that is maintained, the different kinds of projections and expressions, the difference between fields and subexpressions, and so on. After hours playing with the code, I understand some of this stuff -- somewhat.

This kind of stuff could alternatively be explained in the code, which is rather sparsely documented; that might help avoid documentation rot.

@andrewcmyers
Copy link
Collaborator Author

The documentation under "Modules" is more detailed than I realized, but is a little hard to get to. So perhaps some reorg would also help.

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

1 participant