Mention that Cursor is based on rustc's implementation. (#12109)

astral-sh · Jun 30, 2024 · f765d19 · f765d19
1 parent d107968
commit f765d19
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/crates/ruff_python_parser/src/lexer/cursor.rs b/crates/ruff_python_parser/src/lexer/cursor.rs
@@ -5,6 +5,8 @@ use ruff_text_size::{TextLen, TextSize};
 pub(crate) const EOF_CHAR: char = '\0';
 
 /// A cursor represents a pointer in the source code.
+///
+/// Based on [`rustc`'s `Cursor`](https://github.com/rust-lang/rust/blob/d1b7355d3d7b4ead564dbecb1d240fcc74fff21b/compiler/rustc_lexer/src/cursor.rs)
 #[derive(Clone, Debug)]
 pub(super) struct Cursor<'src> {
     /// An iterator over the [`char`]'s of the source code.

diff --git a/crates/ruff_python_trivia/src/cursor.rs b/crates/ruff_python_trivia/src/cursor.rs
@@ -5,6 +5,8 @@ use ruff_text_size::{TextLen, TextSize};
 pub const EOF_CHAR: char = '\0';
 
 /// A [`Cursor`] over a string.
+///
+/// Based on [`rustc`'s `Cursor`](https://github.com/rust-lang/rust/blob/d1b7355d3d7b4ead564dbecb1d240fcc74fff21b/compiler/rustc_lexer/src/cursor.rs)
 #[derive(Debug, Clone)]
 pub struct Cursor<'a> {
     chars: Chars<'a>,