Missing Documentation

[p0rtL6]

There are quite a few methods that are not documented. For example token_next_by, token_matching, and other token methods.

They also lack inline documentation in the signatures and utilize opaque one-letter arguments.

Is this intentional because they're intended to be internal or should they be updated to be easier to use?

I would be more than happy to make a pull request with these changes if needed.

[andialbrecht]

Thanks for raising this!

Currently, only the top-level functions are considered public API. All other methods and functions are internal implementation details.

However, I'm aware that users are working with parsed SQL trees and using this functions. And I'm about to grab this up and formalize - step by step - those functions as public APIs.

[p0rtL6]

Thanks for the info, if there is anything I can help with let me know I'd be more than happy to contribute! In addition (somewhat unrelated) I have found it useful to implement my own methods for traversing a flattened list of tokens which some other people may find useful as well. If that's a feature you are interested in adding I'd be happy to cleanup and pr my changes in here.

[andialbrecht]

Some example would be great! That would give me a clue which of the core functions are useful to others and which should be documented first.

[p0rtL6]

Would it be easier for you to make a pr, make a fork and link it, or make a new repository with just some examples? Would it also be easier to use email or another platform besides GitHub to get in contact?

[p0rtL6]

Just bumping this, what is the best way to contact you?