-
-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
nixpkgs manual, doc Python: render interpreters in a table #246956
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea. Found a few mistakes.
| Packages | Aliases | Interpeters | | ||
|------------|-----------------|------------| | ||
| python27 | python2, python | CPython 2.7 | | ||
| python38 | ` ` | CPython 3.8 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| python38 | ` ` | CPython 3.8 | | |
| python38 | | CPython 3.8 | |
What do we need these backticks for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I kept trying to render the docs without them and they fail. The empty backticks worked as a workaround to be able to render empty cells.
What would be the proper way of getting empty cells? (Maybe it's just a bug that needs to be reported to nixos-render-docs
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deferring to @pennae.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is indeed a bug. #246996
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the prompt fix! I'll wait for the merge to rebase and get rid of the backticks workaround.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you test your changes with the nrd patch applied and report results? just in case you've uncovered any other bugs as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pennae After applying the patch (temp-branch), the whole table can be rendered without the empty code blocks workaround.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome. fix is merged now.
Good idea, thanks! |
compatible with Python 2.7 and 3 are available as `pypy27` and `pypy3`, with | ||
aliases `pypy2` mapping to `pypy27` and `pypy` mapping to `pypy2`. The Nix | ||
expressions for the interpreters can be found in | ||
| Packages | Aliases | Interpreters | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Packages | Aliases | Interpreters | | |
| Package | Aliases | Interpreter | |
One package, has one interpreter, but potentially multiple aliases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point. Plurals can be misleading in table headers, and here I also see now that it's better not to use them to refer to the columns but per-row.
Header updated in latest commit.
`children` only has to be not-None, not also not-[]. empty table cells would can produce an empty inline token and cause these checks to fail, even though the token actually is totally valid. showed up in NixOS#246956 (comment).
`children` only has to be not-None, not also not-[]. empty table cells would can produce an empty inline token and cause these checks to fail, even though the token actually is totally valid. showed up in #246956 (comment).
The current paragraph presenting Python interpreters is verbose and hinders clarity. The information provided is well suited to be rendered as a table. Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
… interpreters' table
67f47f5
to
b80b5c3
Compare
@mweinelt with the nrd fix merged, all the feedback so far has been addressed. Are there any other changes required? |
The current paragraph presenting Python interpreters is verbose and hinders clarity. The information provided is well suited to be rendered as a table.
tag:alejandrosamemightyiam