Document privacy invariant of SyntaxPtr

diff --git a/crates/syntax/src/ptr.rs b/crates/syntax/src/ptr.rs
index ca79577471321414ba7da95bfdde01e8f0cb7177..d3fb7a5d98f1e8717d70c20ac2eb22d247c9b0e0 100644 (file)
--- a/crates/syntax/src/ptr.rs
+++ b/crates/syntax/src/ptr.rs
@@ -12,6 +12,8 @@
 /// specific node across reparses of the same file.
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 pub struct SyntaxNodePtr {
+    // Don't expose this field further. At some point, we might want to replace
+    // range with node id.
     pub(crate) range: TextRange,
     kind: SyntaxKind,
 }