Python user documentation: fix code highlighting, use valid Nix expressions #23535

alexeymuranov · 2017-03-05T16:56:18Z

Fix code syntax highlighting by specifying language in every code block and adding some context to Nix code blocks to make them valid expressions. Use the same markup style for all code blocks.

mention-bot · 2017-03-05T16:56:19Z

@alexeymuranov, thanks for your PR! By analyzing the history of the files in this pull request, we identified @FRidh, @globin and @bennofs to be potential reviewers.

matthiasbeyer · 2017-03-05T17:14:33Z

doc/languages-frameworks/python.md

-  };
+{
+  # ...
+  toolz = buildPythonPackage rec{


While you're at it, you could add a space after the rec keyword, for cleaness! ❓

matthiasbeyer · 2017-03-05T17:14:54Z

doc/languages-frameworks/python.md

+    name = "toolz-${version}";
+    version = "0.7.4";
+
+    src = pkgs.fetchurl{


Same here after fetchurl.

matthiasbeyer · 2017-03-05T17:15:54Z

doc/languages-frameworks/python.md


-  buildInputs = with self; [ pkgs.libxml2 pkgs.libxslt ];
+    buildInputs = with self; [ pkgs.libxml2 pkgs.libxslt ];


Why with self if you only use pkgs.<something>?

I only reformatted the source. What is self?

I'm not sure, but I think we don't need it at that location. Probably should ask one of the python guys in here...

But this is Nix, not Python. I just don't know what self in Nix is. Nix manual does not mention it.

No, I mean we should ask the python guys from nixpkgs to ensure that we can remove self here.

self is commonly used to refer to the attribute set currently in, so this would bring everything from the current set into the scope of the expression. But my guess is that we do not need it, as we do not refer to something from self, like self.somepackage, but rather to pkgs.somepackage - so bringing pkgs into scope like so:

with pkgs; [ libxml2 libxslt ];

would make more sense to me. But as said: I'm not into the python-packaging ecosystem that much, so I would say we need someone from the python packaging team to approve what I suggest.

Ok, but i suppose it is not necessary to fix everything in one go.

matthiasbeyer · 2017-03-05T17:16:19Z

doc/languages-frameworks/python.md


-  buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];
+    buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];


Can we consider using with pkgs here?

One should try to avoid with because it can shadow other packages.

matthiasbeyer · 2017-03-05T17:17:55Z

doc/languages-frameworks/python.md

+    meta = {
+      homepage = http://twistedmatrix.com/;
+      description = "Twisted, an event-driven networking engine written in Python";
+      license = stdenv.lib.licenses.mit; };


Sure we need this closing };?

No, we don't, thanks.

matthiasbeyer · 2017-03-05T17:23:01Z

doc/languages-frameworks/python.md

-    Permission denied
-
-This is a [known bug](https://github.com/pypa/setuptools/issues/130) in setuptools.
+```


I'm not entirely sure, but it could be that we need blank lines before and after code listings that are introduced with three back-ticks... ?

Hm, i never leave a blank line if it is the same paragraph, it renders fine on GitHub, but possibly it is not correct Markdown...

I didn't find any mention of required blank lines before and after "fenced" code blocks, and both GitHub and https://stackedit.io/editor are rendering fine without.

Remember that this file is converted with pandoc to docbook.

I tried with http://pandoc.org/try/ , i do not see any issues.

alexeymuranov · 2017-03-05T18:01:43Z

doc/languages-frameworks/python.md

+    # FIXME!
+    LDFLAGS="-L${pkgs.fftw.dev}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib"
+    CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include"
+    '';


@matthiasbeyer, @FRidh, what is actually supposed to be here?

exactly that. Why?

This is not even valid Nix.

and why not? Check python-packages.nix where it is used.

There is no LDFLAGS in https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/python-packages.nix

FRidh · 2017-03-05T18:24:34Z

The latest version uses ``` preConfigure = '' export LDFLAGS="-L${pkgs.fftw.out}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib" export CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include" ''; ```

…

On Sun, Mar 5, 2017 at 7:21 PM, Alexey Muranov ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In doc/languages-frameworks/python.md <#23535 (comment)>: > - LDFLAGS="-L${pkgs.fftw.dev}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib" - CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include" - ''; + # FIXME! + LDFLAGS="-L${pkgs.fftw.dev}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib" + CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include" + ''; There is no LDFLAGS in https://github.com/NixOS/ nixpkgs/blob/master/pkgs/top-level/python-packages.nix — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#23535 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACB872QoGieMkkQsangBIWINzsbM7ItLks5riv0fgaJpZM4MTeGV> .

alexeymuranov · 2017-03-05T18:36:13Z

Sorry, i do not know where to look for the "latest version". Anyway, i see now that apparently it is

preConfigure = ''

that is missing, thanks.

FRidh · 2017-03-05T18:38:51Z

Its not really missing. The way it is currently in the docs is valid as well.

alexeymuranov · 2017-03-05T18:43:15Z

The way it is currently in the docs is not even valid Nix.

matthiasbeyer · 2017-03-05T18:59:24Z

What you highlighted with your last commit is indeed valid nix. At least I fail to figure out what would be non-valid in there...

alexeymuranov · 2017-03-05T19:04:57Z

I suppose that

{
  LDFLAGS="-L${pkgs.fftw.dev}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib"
  CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include"
  '';
}

is then also valid Nix, right?

matthiasbeyer · 2017-03-05T19:19:03Z

Ah, now I see what you mean... Yep, sorry, this is not valid Nix, you are right!

FRidh · 2017-03-05T19:20:53Z

Indeed, that would give a syntax error.

alexeymuranov · 2017-03-05T19:23:44Z

Yes, and for a good reason. Should i add preConfigure = '' or remove ''; and add a ;? (I am not sure.)

FRidh · 2017-03-05T19:30:15Z

The former would have the preference.

Fix code syntax highlighting by specifying language in every code block and adding some context to Nix code blocks to make them valid expressions. Use the same markup style for all code blocks. Reformat some code blocks.

Fix code syntax highlighting by specifying language in every code block and adding some context to Nix code blocks to make them valid expressions. Use the same markup style for all code blocks. Reformat some code blocks. fixes #23535 (cherry picked from commit 34afc31)

matthiasbeyer requested changes Mar 5, 2017

View reviewed changes

alexeymuranov commented Mar 5, 2017

View reviewed changes

alexeymuranov added 3 commits March 6, 2017 10:30

whitespace

6f6bc1e

fix code highlighting, use valid Nix expressions

bef15a8

Fix code syntax highlighting by specifying language in every code block and adding some context to Nix code blocks to make them valid expressions. Use the same markup style for all code blocks. Reformat some code blocks.

fix missing code line

7132f84

Mic92 closed this in 34afc31 Mar 6, 2017

alexeymuranov deleted the python-user-documentation branch March 6, 2017 17:16

FRidh mentioned this pull request Mar 18, 2017

doc: enable code syntax highlighting #23627

Merged

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python user documentation: fix code highlighting, use valid Nix expressions #23535

Python user documentation: fix code highlighting, use valid Nix expressions #23535

alexeymuranov commented Mar 5, 2017

mention-bot commented Mar 5, 2017

matthiasbeyer Mar 5, 2017

matthiasbeyer Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

FRidh Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

matthiasbeyer Mar 5, 2017

alexeymuranov Mar 5, 2017

alexeymuranov Mar 6, 2017

FRidh Mar 6, 2017

alexeymuranov Mar 6, 2017

alexeymuranov Mar 5, 2017

FRidh Mar 5, 2017

alexeymuranov Mar 5, 2017

FRidh Mar 5, 2017

alexeymuranov Mar 5, 2017

FRidh commented Mar 5, 2017 via email

alexeymuranov commented Mar 5, 2017

FRidh commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

matthiasbeyer commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

matthiasbeyer commented Mar 5, 2017

FRidh commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

FRidh commented Mar 5, 2017


		buildInputs = with self; [ pkgs.libxml2 pkgs.libxslt ];
		buildInputs = with self; [ pkgs.libxml2 pkgs.libxslt ];


		buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];
		buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];

Python user documentation: fix code highlighting, use valid Nix expressions #23535

Python user documentation: fix code highlighting, use valid Nix expressions #23535

Conversation

alexeymuranov commented Mar 5, 2017

mention-bot commented Mar 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FRidh commented Mar 5, 2017 via email

alexeymuranov commented Mar 5, 2017

FRidh commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

matthiasbeyer commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

matthiasbeyer commented Mar 5, 2017

FRidh commented Mar 5, 2017

alexeymuranov commented Mar 5, 2017

FRidh commented Mar 5, 2017