From b2d53203f2c1cc2ba898e1fe22f61d781ffb89f9 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Fri, 26 Jul 2024 16:03:13 +0200 Subject: [PATCH] docs: show `pyproject = true;` instead of `format = "pyproject";` every other format is deprecated, so to imply that people should be setting it is misleading (`pyproject = true` should also go away eventually, but is the way until then) --- doc/languages-frameworks/python.section.md | 3 ++- doc/languages-frameworks/rust.section.md | 3 +-- 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 48c32f324df4..1a782303f9aa 100644 --- a/doc/languages-frameworks/rust.section.md +++ b/doc/languages-frameworks/rust.section.md @@ -645,6 +645,7 @@ builds the `retworkx` Python package. `fetchCargoTarball` and buildPythonPackage rec { pname = "retworkx"; version = "0.6.0"; + pyproject = true; src = fetchFromGitHub { owner = "Qiskit"; @@ -659,8 +660,6 @@ buildPythonPackage rec { hash = "sha256-heOBK8qi2nuc/Ib+I/vLzZ1fUUD/G/KTw9d7M4Hz5O0="; }; - format = "pyproject"; - nativeBuildInputs = with rustPlatform; [ cargoSetupHook maturinBuildHook ]; # ...