GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||||||||||||||||||||||||||||||||||||||||||||
GeezerVison is showing github.com — DOC: explain WSL GUI backend setup by SIBTAIN-ASAD · Pull Request #32386 · matplotlib/matplotlib ConversationCloses #32381 Matplotlib can use the GUI environment provided by WSLg when a supported toolkit is installed, but the backend guide did not explain the setup or how to diagnose a missing display. This adds a focused WSL section to the backend troubleshooting guide covering:
Verification:
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
All reactions
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page.
Author
All reactions
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page.
|
There was an error while loading. Please reload this page.
|
This needs some work. It does not tell users how to see if WSLg is available, how to set those env variables, or how to persist this setup. I think this is not an appropriate section of docs to use AI to write (even more so than usual) - it needs someone working through it from scratch from the user's perspective to ensure all steps are covered. I'm going to mark this as an autoclose candidate unless it's updated to show that a human wrote it and worked through the written process. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
⏰ This pull request might be automatically closed in two weeks from now. Thank you for your contribution to Matplotlib and for the effort you have put into this PR. This pull request does not yet meet the quality and clarity standards needed for an effective review. Project maintainers have limited time for code reviews, and our goal is to prioritize well-prepared contributions to keep Matplotlib maintainable. Matplotlib maintainers cannot provide one-to-one guidance on this PR. However, if you ask focused, well-researched questions, a community member may be willing to help. 💬 To increase the chance of a productive review:
As the author, you are responsible for driving this PR, which entails doing necessary background research as well as presenting its context and your thought process. If you are a new contributor, or do not know how to fulfill these requirements, we recommend that you familiarize yourself with Matplotlib's development conventions or engage with the community via our Discourse or one of our meetings before submitting code. If you substantially improve this PR within two weeks, leave a comment and a team member may remove the |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
I will add that the addition does not belong where it is. It breaks up an existing section and makes it look like the notebook, etc. troubleshooting steps are specific to WSL. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
I would put it around L203. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Thanks for the guidance. I moved the WSL section next to the backend-selection guidance (around the requested location) so it no longer interrupts the troubleshooting flow. The section now links back to the backend selection and builtin-backend guidance, and the change is pushed in 61e03f3. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
That makes sense. I reduced the WSL guidance to a short note covering WSLg, the DISPLAY/WAYLAND_DISPLAY check, and the headless Agg fallback. The update is pushed in 399236a. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
sorry this got stalled
Sorry, something went wrong.
There was an error while loading. Please reload this page.
| ``WAYLAND_DISPLAY`` is set in the shell where Python is started. You can | ||
| inspect the selected backend with: | ||
|
|
||
| .. code-block:: python3 | ||
|
|
||
| import matplotlib | ||
|
|
||
| print(matplotlib.get_backend()) | ||
|
|
||
| If no display is available (for example, when running a script in a headless | ||
| WSL environment), select the non-interactive ``Agg`` backend and save figures | ||
| to files instead. See :ref:`the-builtin-backends` for the available | ||
| interactive backends and :ref:`selecting-a-backend` for ways to configure a | ||
| backend explicitly. |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
This is generic advice for all the backends, so can it be factored out that way?
Sorry, something went wrong.
There was an error while loading. Please reload this page.
At least 1 approving review is required to merge this pull request.
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
[ENH]: WSL support
There was an error while loading. Please reload this page.