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

Docs? #210

Open
WillsterJohnson opened this issue Jul 14, 2024 · 0 comments
Open

Docs? #210

WillsterJohnson opened this issue Jul 14, 2024 · 0 comments

Comments

@WillsterJohnson
Copy link

It's quite unclear what behaviours which methods have and under which circumstances.

For example, I've just used cursor.gotoFirstChildForIndex(2), and it has set the new cursor.currentNode to what was previously at cursor.currentNode.children[0]. What was the point of passing 2? Have I misinterpreted this, and it isn't a method for 'go to the Nth child of the current node'?

It would also be useful to update the types to reflect what is actually returned on the various objects. For example, Parser.SyntaxNode.fields exists at runtime, but is missing from the types. If it's deprecated that's fine, but it should at least be present and marked @deprecated rather than being a weird discovery at runtime while debugging a compiler.

Really just need a few basic pointers regarding what thing are/do, even if it's just a line of JSDoc on each of the interface members. I can't find any documentation for this package.

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