Skip to content

doc/languages-frameworks/python: Reword section to make commit rules a bit clearer#339643

Merged
FliegendeWurst merged 2 commits intoNixOS:masterfrom
Pandapip1:minor-python-section-reword
Dec 9, 2024
Merged

doc/languages-frameworks/python: Reword section to make commit rules a bit clearer#339643
FliegendeWurst merged 2 commits intoNixOS:masterfrom
Pandapip1:minor-python-section-reword

Conversation

@Pandapip1
Copy link
Member

Description of changes

See the minor confusion at #339136 (comment)

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: python Python is a high-level, general-purpose programming language. 8.has: documentation This PR adds or changes documentation labels Sep 4, 2024
@donovanglover donovanglover added the 12.approvals: 1 This PR was reviewed and approved by one person. label Sep 4, 2024
Comment on lines 2022 to 2021
Copy link
Member

@emilazy emilazy Sep 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, this is out of date and ofborg will build both package sets if you use python3Packages (not sure if this was ever true). Therefore this advice is actually counterproductive.

Disclaimer: I have not verified this recently.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that #165994 fixed this, but maybe it regressed since or something.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

python3Packages does not work on ofborg, I (wearily) nit about it for that reason.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also just to encourage good practices from people who are reading too quickly, we should either specify python312Packages specifically or say python3xxPackages to be more general IMO.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I swear it worked at one point. Maybe I’m just imagining things or maybe it broke again. I’m not the only person who remembered it working since someone else said to me recently that it had been fixed at some point. :(

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been checking python libraries for over a year and have never had it work. Maybe they missed that someone ran it manually.
People don't read much documentation, but they often ask reviewers to show them documentation.
It needs to be clearly stated to avoid unnecessary discussion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@emilazy emilazy Sep 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think python3{11,12}Packages.… should work, right? Maybe we should prefer that to check both supported versions. (I don’t suppose we can get away with python3*Packages?)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I don't want to complicate it because that can be checked by nixpkgs-review.
In my experience, just checking one version is usually enough to catch build failures on aarch64-linux or darwin that are often overlooked.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. labels Sep 4, 2024
Copy link
Contributor

@eclairevoyant eclairevoyant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the changes read naturally and it's certainly more explicit. Thank you for the PR!

@Pandapip1 Pandapip1 force-pushed the minor-python-section-reword branch from 956d597 to 00a43d7 Compare September 5, 2024 02:53
@wegank wegank removed the 12.approvals: 1 This PR was reviewed and approved by one person. label Sep 6, 2024
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/4801

@wegank wegank added the 12.approvals: 3+ This PR was reviewed and approved by three or more persons. label Dec 6, 2024
@FliegendeWurst FliegendeWurst merged commit e4c9d40 into NixOS:master Dec 9, 2024
@nixpkgs-ci
Copy link
Contributor

nixpkgs-ci bot commented Dec 9, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: python Python is a high-level, general-purpose programming language. 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-linux: 1 This PR causes 1 package to rebuild on Linux. 12.approvals: 3+ This PR was reviewed and approved by three or more persons.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants