Unverified Commit b2d53203 authored by Arnout Engelen's avatar Arnout Engelen
Browse files

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)
parent 68c9ed8b

doc/languages-frameworks/python.section.md

+2 −1
Original line number Diff line number Diff line
@@ -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`

doc/languages-frameworks/rust.section.md

+1 −2
Original line number Diff line number Diff line
@@ -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 ];



  # ...