Add some useful doc comments about node ids #3364
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi! I'm currently using
tree-sitter
to power a plain-text presentation program I'm making, which has a Language Server integration. As a user is editing, I tried to associate slides with theNode
IDs they corresponded to, that way I could easily update a slideshow preview on every keystrokeI found that this didn't work as expected, but it did work when I took the
Node
ID of a specific token within each slide, in my case, the first bracketI was under the impression that if a Node was not marked as having changed, that it would always be reused. I found that this was not the case, and added some doc comments to the
id()
function under theNode
struct. If there's anywhere else this information should go, I'll update this PR and put it there too.tree-sitter
has been such an amazing tool to use, and integrate into everything I'm doing, and I can't thank y'all enough for making it 馃槃