about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorAleksana2024-07-31 10:09:20 +0800
committerGitHub2024-07-31 10:09:20 +0800
commitfb3d86ee0d57c8cdfc363e2108c37af3887f01b4 (patch)
tree5c9e3c19adc6c139d69e2ec9cc1a03f337354605 /doc
parent5fbeaf6d89ff1ff08a59a0f0b34d6eb33fb75307 (diff)
parentb2d53203f2c1cc2ba898e1fe22f61d781ffb89f9 (diff)
Merge pull request #330176 from raboof/docs-show-pyproject-instead-of-format
docs: show `pyproject = true;` instead of `format = "pyproject";`
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/python.section.md3
-rw-r--r--doc/languages-frameworks/rust.section.md3
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index 519fd6fbf960..5a2e2de2edef 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -162,7 +162,8 @@ following are specific to `buildPythonPackage`:
 * `dontWrapPythonPrograms ? false`: Skip wrapping of Python programs.
 * `permitUserSite ? false`: Skip setting the `PYTHONNOUSERSITE` environment
   variable in wrapped programs.
-* `pyproject`: Whether the pyproject format should be used. When set to `true`,
+* `pyproject`: Whether the pyproject format should be used. As all other formats
+  are deprecated, you are recommended to set this to `true`. When you do so,
   `pypaBuildHook` will be used, and you can add the required build dependencies
   from `build-system.requires` to `build-system`. Note that the pyproject
   format falls back to using `setuptools`, so you can use `pyproject = true`
diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md
index a54ea6efa4f4..15f16879a5b4 100644
--- a/doc/languages-frameworks/rust.section.md
+++ b/doc/languages-frameworks/rust.section.md
@@ -642,6 +642,7 @@ builds the `retworkx` Python package. `fetchCargoTarball` and
 buildPythonPackage rec {
   pname = "retworkx";
   version = "0.6.0";
+  pyproject = true;
 
   src = fetchFromGitHub {
     owner = "Qiskit";
@@ -656,8 +657,6 @@ buildPythonPackage rec {
     hash = "sha256-heOBK8qi2nuc/Ib+I/vLzZ1fUUD/G/KTw9d7M4Hz5O0=";
   };
 
-  format = "pyproject";
-
   nativeBuildInputs = with rustPlatform; [ cargoSetupHook maturinBuildHook ];
 
   # ...