Skip to content

Commit 9a35763

Browse files
committed
update docs
1 parent 86583c1 commit 9a35763

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

crates/ruff_python_parser/src/python_version.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ mod pyversion {
99

1010
use pep440_rs::{Operator, Version as Pep440Version, Version, VersionSpecifiers};
1111

12+
/// Representation of supported Python versions.
13+
///
14+
/// Unlike [`PythonVersion`](super::PythonVersion), this is deserialized from versions like
15+
/// `py39` rather than dotted versions like `3.9`.
1216
#[derive(Clone, Copy, Debug, PartialOrd, Ord, PartialEq, Eq, Default, EnumIter)]
1317
#[cfg_attr(feature = "ruff_macros", derive(ruff_macros::CacheKey))]
1418
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
@@ -111,8 +115,8 @@ mod pyversion {
111115

112116
/// Representation of a Python version.
113117
///
114-
/// Unlike the `TargetVersion` enums in the CLI crates,
115-
/// this does not necessarily represent a Python version that we actually support.
118+
/// Unlike the [`PyVersion`], this does not necessarily represent a Python version that we actually
119+
/// support.
116120
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
117121
#[cfg_attr(feature = "wasm-bindgen", wasm_bindgen::prelude::wasm_bindgen)]
118122
pub struct PythonVersion {

ruff.schema.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)