From c14e30ad093bc6b0147c269f7775e438e537bdf8 Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Mon, 19 Aug 2024 17:24:16 -0400 Subject: [PATCH] pep508: fix doc test Indented blocks in Markdown are treated as code blocks, and rustdoc treats all unadorned code blocks as Rust doctests. Since this wasn't intended as a doctest and isn't valid Rust, it makes `cargo test --doc` fail. We fix this by using an explicit code block labeled as `text`. --- crates/pep508-rs/src/marker/parse.rs | 6 ++++-- crates/uv-resolver/src/error.rs | 20 ++++++++++++-------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/crates/pep508-rs/src/marker/parse.rs b/crates/pep508-rs/src/marker/parse.rs index 4faa534f3192..b2a10961eeec 100644 --- a/crates/pep508-rs/src/marker/parse.rs +++ b/crates/pep508-rs/src/marker/parse.rs @@ -256,8 +256,10 @@ pub(crate) fn parse_marker_key_op_value( /// relatively rare so the trade-off is acceptable. /// /// The following limited expression is supported: -/// -/// [not] in ' [additional versions]' +/// +/// ```text +/// [not] in ' [additional versions]' +/// ``` /// /// where the version is PEP 440 compliant. Arbitrary whitespace is allowed between versions. /// diff --git a/crates/uv-resolver/src/error.rs b/crates/uv-resolver/src/error.rs index 3002af99b29b..418af506e73b 100644 --- a/crates/uv-resolver/src/error.rs +++ b/crates/uv-resolver/src/error.rs @@ -367,18 +367,22 @@ fn collapse_no_versions_of_workspace_members( /// Given a [`DerivationTree`], collapse `NoVersions` incompatibilities that are redundant children /// of a dependency. For example, if we have a tree like: -/// -/// A>=1,<2 depends on B -/// A has no versions >1,<2 -/// C depends on A>=1,<2 +/// +/// ```text +/// A>=1,<2 depends on B +/// A has no versions >1,<2 +/// C depends on A>=1,<2 +/// ``` /// /// We can simplify this to `C depends A>=1 and A>=1 depends on B so C depends on B` without /// explaining that there are no other versions of A. This is dependent on range of A in "A depends /// on" being a subset of range of A in "depends on A". For example, in a tree like: /// -/// A>=1,<3 depends on B -/// A has no versions >2,<3 -/// C depends on A>=2,<3 +/// ```text +/// A>=1,<3 depends on B +/// A has no versions >2,<3 +/// C depends on A>=2,<3 +/// ``` /// /// We cannot say `C depends on A>=2 and A>=1 depends on B so C depends on B` because there is a /// hole in the range — `A>=1,<3` is not a subset of `A>=2,<3`. @@ -444,7 +448,7 @@ fn collapse_redundant_depends_on_no_versions_inner( DerivationTree::External(External::NoVersions(no_versions_package, _)), ) // And these incompatibilities (and the parent incompatibility) all are referring to - // the same package... + // the same package... if no_versions_package == dependency_package && package == no_versions_package // And parent dependency versions are a subset of the versions in this tree...