Skip to content

Commit f486e76

Browse files
committed
update docstrings to mention ParserOptions
1 parent ea48c38 commit f486e76

File tree

1 file changed

+5
-5
lines changed
  • crates/ruff_python_parser/src

1 file changed

+5
-5
lines changed

crates/ruff_python_parser/src/lib.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -236,11 +236,11 @@ pub fn parse_string_annotation(
236236
}
237237
}
238238

239-
/// Parse the given Python source code using the specified [`Mode`].
239+
/// Parse the given Python source code using the specified [`ParserOptions`].
240240
///
241-
/// This function is the most general function to parse Python code. Based on the [`Mode`] supplied,
242-
/// it can be used to parse a single expression, a full Python program, an interactive expression
243-
/// or a Python program containing IPython escape commands.
241+
/// This function is the most general function to parse Python code. Based on the [`Mode`] supplied
242+
/// via the [`ParserOptions`], it can be used to parse a single expression, a full Python program,
243+
/// an interactive expression or a Python program containing IPython escape commands.
244244
///
245245
/// # Example
246246
///
@@ -286,7 +286,7 @@ pub fn parse(source: &str, options: ParserOptions) -> Result<Parsed<Mod>, ParseE
286286
parse_unchecked(source, options).into_result()
287287
}
288288

289-
/// Parse the given Python source code using the specified [`Mode`].
289+
/// Parse the given Python source code using the specified [`ParserOptions`].
290290
///
291291
/// This is same as the [`parse`] function except that it doesn't check for any [`ParseError`]
292292
/// and returns the [`Parsed`] as is.

0 commit comments

Comments
 (0)