Merge pull request #1358 from PyO3/interpreter-doc-string

Clarify `--interpreter` value
PyO3 · Dec 16, 2022 · e0b6a74 · e0b6a74
2 parents 968202a + 5622795
commit e0b6a74
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 7 deletions.
diff --git a/guide/src/develop.md b/guide/src/develop.md
@@ -14,7 +14,9 @@ Arguments:
 
 Options:
   -b, --bindings <BINDINGS>
-          Which kind of bindings to use. Possible values are pyo3, rust-cpython, cffi and bin
+          Which kind of bindings to use
+
+          [possible values: pyo3, pyo3-ffi, rust-cpython, cffi, uniffi, bin]
 
   -r, --release
           Pass --release to cargo

diff --git a/guide/src/distribution.md b/guide/src/distribution.md
@@ -101,15 +101,16 @@ Options:
           This option is ignored on all non-linux platforms
 
   -i, --interpreter [<INTERPRETER>...]
-          The python versions to build wheels for, given as the names of the interpreters
+          The python versions to build wheels for, given as the executables of interpreters such as
+          `python3.9` or `/usr/bin/python3.8`
 
   -f, --find-interpreter
           Find interpreters from the host machine
 
   -b, --bindings <BINDINGS>
           Which kind of bindings to use
 
-          [possible values: pyo3, pyo3-ffi, rust-cpython, cffi, bin]
+          [possible values: pyo3, pyo3-ffi, rust-cpython, cffi, uniffi, bin]
 
   -o, --out <OUT>
           The directory to store the built wheels in. Defaults to a new "wheels" directory in the

diff --git a/src/build_options.rs b/src/build_options.rs
@@ -152,8 +152,8 @@ pub struct BuildOptions {
     )]
     pub platform_tag: Vec<PlatformTag>,
 
-    /// The python versions to build wheels for, given as the names of the
-    /// interpreters.
+    /// The python versions to build wheels for, given as the executables of
+    /// interpreters such as `python3.9` or `/usr/bin/python3.8`.
     #[arg(short, long, num_args = 0.., action = clap::ArgAction::Append)]
     pub interpreter: Vec<PathBuf>,
 

diff --git a/tests/cmd/build.stdout b/tests/cmd/build.stdout
@@ -31,7 +31,8 @@ Options:
           This option is ignored on all non-linux platforms
 
   -i, --interpreter [<INTERPRETER>...]
-          The python versions to build wheels for, given as the names of the interpreters
+          The python versions to build wheels for, given as the executables of interpreters such as
+          `python3.9` or `/usr/bin/python3.8`
 
   -f, --find-interpreter
           Find interpreters from the host machine

diff --git a/tests/cmd/publish.stdout b/tests/cmd/publish.stdout
@@ -65,7 +65,8 @@ Options:
           This option is ignored on all non-linux platforms
 
   -i, --interpreter [<INTERPRETER>...]
-          The python versions to build wheels for, given as the names of the interpreters
+          The python versions to build wheels for, given as the executables of interpreters such as
+          `python3.9` or `/usr/bin/python3.8`
 
   -f, --find-interpreter
           Find interpreters from the host machine