Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/python: add pytestCheckHook section #95700

Merged
merged 2 commits into from Aug 18, 2020
Merged

doc/python: add pytestCheckHook section #95700

merged 2 commits into from Aug 18, 2020

Conversation

jonringer
Copy link
Contributor

@jonringer jonringer commented Aug 17, 2020 •
edited

Motivation for this change

noticed in #95605 that we didn't have a good example of how to use pytestCheckHook

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@jonringer jonringer requested a review from FRidh as a code owner August 17, 2020 17:27
drewrisinger
drewrisinger suggested changes Aug 17, 2020
View reviewed changes
Copy link
Contributor

@drewrisinger drewrisinger left a comment

Choose a reason for hiding this comment

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

Looks pretty good to me! This would've been very helpful when I was first starting to learn nix. Thanks for taking the time to write this up. Few spelling/wording changes suggested.

doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
doc/languages-frameworks/python.section.md Outdated Show resolved Hide resolved
@jonringer
Copy link
Contributor Author

@drewrisinger thanks for the review, applied/adapted most of the suggestions

drewrisinger
drewrisinger approved these changes Aug 17, 2020
View reviewed changes
Copy link
Contributor

@drewrisinger drewrisinger left a comment

Choose a reason for hiding this comment

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

LGTM. Only last suggestion would be a link to the pytest documentation for more details: https://docs.pytest.org/en/stable/usage.html

@jonringer
Copy link
Contributor Author

jonringer commented Aug 17, 2020 •
edited

maybe once the ecosystem stabilizes around pytest again, see #95609 (comment) and #95609 (comment) but I'm just afraid that they will be fed information which is against the common practices in nixpkgs (currently)

@FRidh FRidh merged commit 6770ab0 into NixOS:master Aug 18, 2020
@jonringer jonringer deleted the doc-pytestcheckhook branch August 18, 2020 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drewrisinger drewrisinger drewrisinger approved these changes

@FRidh FRidh Awaiting requested review from FRidh

Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jonringer @drewrisinger @FRidh