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.

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

doc/python: cleanup examples, references #58160

Merged
merged 3 commits into from Apr 8, 2019

Conversation

worldofpeace
Copy link
Contributor

Motivation for this change

1e86c0a let me actually see the examples we had, so I thought that we should improve them further.

This was done fairly quickly, so please tell me if there's something else I should touch.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nix-review --run "nix-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)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@@ -585,11 +582,6 @@ The `buildPythonPackage` mainly does four things:
environment variable and add dependent libraries to script's `sys.path`.
* In the `installCheck` phase, `${python.interpreter} setup.py test` is ran.

As in Perl, dependencies on other Python packages can be specified in the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This wasn't the best description, and the reference to perl didn't seem right here.

There's also

The `stdenv.mkDerivation` function accepts various parameters for describing build inputs (see "Specifying dependencies"). The following are of special
interest for Python packages

A bit below which is a good explanation with buildPython* in mind.

Copy link
Member

@FRidh FRidh left a comment

Choose a reason for hiding this comment

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

Did not check the rendered result but the changes itself seem good to me.

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
@worldofpeace
Copy link
Contributor Author

In a followup to this (not completely related) would like to build off of 4bd168e because Handling dependencies doesn't reflect this in an introductory way.

@worldofpeace
Copy link
Contributor Author

@FRidh @dotlambda Can either of you check off on this?

Copy link
Member

@FRidh FRidh left a comment

Choose a reason for hiding this comment

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

looks OK

@worldofpeace worldofpeace merged commit 82688a1 into NixOS:master Apr 8, 2019
@worldofpeace worldofpeace deleted the python-doc/cleanup branch April 8, 2019 16:43
@worldofpeace
Copy link
Contributor Author

lol, and I merged with fixup commits 🤣

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

Successfully merging this pull request may close these issues.

None yet

4 participants