Updated docs for gtk-prerequisites.md.
#4065
Conversation
Informing python development libraries installation requirement if using specific python version.
freakboy3742
left a comment
freakboy3742
left a comment
There was a problem hiding this comment.
Thanks for the PR; a couple of notes inline.
changes/3861.doc.md
Outdated
There was a problem hiding this comment.
The changenote is a draft of a release note. That means it should be phrased in terms of "the amazing new feature that now exists!", not a commit message describing the minor details of what has been changed. Something like "GTK documentation now includes details on using a specific Python version" would be the framing here.
However - in this case, while important, the change is a relatively minor improvement to docs. It doesn't really warrant a line in the release notes. To that end, it should be a misc.md.
|
|
||
| As for Arch/Manjaro/FreeBSD the python development libraries are included as part of `python3`. | ||
|
|
||
| /// |
There was a problem hiding this comment.
We already have specific subsections for each platform - platform specific notes should be part of those platforms, not a separate set of bullet points.
In the case of Debian/Ubuntu: Debian itself only includes a single Python version as part of system packages; if a user is hitting this, it's because they're using Deadsnakes or an equivalent. That's worth calling out specifically.
There was a problem hiding this comment.
Hi @freakboy3742 , so you would suggest breaking all the bullet points into the respective platform specific notes? Am I getting it right?
There was a problem hiding this comment.
Should I add
If you are using an additional Python version from Deadsnakes or a similar third‑party repository, you must also install the corresponding pythonX.Y-dev package for that interpreter (for example, python3.12-dev
There was a problem hiding this comment.
Hi @freakboy3742 , so you would suggest breaking all the bullet points into the respective platform specific notes? Am I getting it right?
That's correct.
Should I add
If you are using an additional Python version from Deadsnakes or a similar third‑party repository, you must also install the corresponding pythonX.Y-dev package for that interpreter (for example, python3.12-dev
Something like that, yes.
|
One last thing - there's also a prerequisites document for Qt in the same folder that will require very similar changes. |
…pWC/toga into update-docs-gtk-prerequisites
Modified docs placement in gtk-prerequisite. Change description for change note 3861. Added python development lib requirement for different python version for qt-prerequisite.
|
Updated the docs based on the comment given. |
freakboy3742
left a comment
freakboy3742
left a comment
There was a problem hiding this comment.
Thanks; I've applied some additional fixes, tweaking grammar, and changing ordering so that we clarify the instructions after we've given them - but this was helpful as a first draft.
2 participants
Added an info section in
toga/docs/en/reference/platforms/linux/gtk-prerequisites.mdto inform user python development libraries installation requirement if using specific python version.This solve the problem for user who would like to use specific python version for toga. As by default python3 is used and python3 development libraries are installed. For different python version, user would have to install the specific version of python3 development libraries.
Fixes #3861
PR Checklist: