Auto merge of #13202 - hi-rustin:rustin-patch-spec-example, r=weihanglo

refactor: give some better examples for package ID spec
rust-lang · Dec 25, 2023 · 4e792c2 · 4e792c2
2 parents c2408a7 + ad18dd0
commit 4e792c2
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/crates/cargo-util-schemas/src/core/package_id_spec.rs b/crates/cargo-util-schemas/src/core/package_id_spec.rs
@@ -64,13 +64,15 @@ impl PackageIdSpec {
     /// use cargo_util_schemas::core::PackageIdSpec;
     ///
     /// let specs = vec![
-    ///     "https://crates.io/foo",
-    ///     "https://crates.io/foo#1.2.3",
-    ///     "https://crates.io/foo#bar:1.2.3",
-    ///     "https://crates.io/foo#bar@1.2.3",
     ///     "foo",
+    ///     "foo@1.4",
+    ///     "foo@1.4.3",
     ///     "foo:1.2.3",
-    ///     "foo@1.2.3",
+    ///     "https://github.com/rust-lang/crates.io-index#foo",
+    ///     "https://github.com/rust-lang/crates.io-index#foo@1.4.3",
+    ///     "ssh://git@github.com/rust-lang/foo.git#foo@1.4.3",
+    ///     "file:///path/to/my/project/foo",
+    ///     "file:///path/to/my/project/foo#1.1.8"
     /// ];
     /// for spec in specs {
     ///     assert!(PackageIdSpec::parse(spec).is_ok());