Reword docs about fallbacks on headless linux. #20664
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
reviewed
Jul 18, 2021
tutorials/introductory/usage.py
Outdated
Comment on lines
302
to
305
| # loop is already running. An interactive backend is usually preferred (at | ||
| # least tkagg should be available); as an exception, on Linux, if Matplotlib | ||
| # cannot connect to either an X display or a Wayland display, the system is | ||
| # considered "headless" and a noninteractive backend (agg) is used. |
There was a problem hiding this comment.
Can this be less technical and more to the point? e.g.
Suggested change
| # loop is already running. An interactive backend is usually preferred (at | |
| # least tkagg should be available); as an exception, on Linux, if Matplotlib | |
| # cannot connect to either an X display or a Wayland display, the system is | |
| # considered "headless" and a noninteractive backend (agg) is used. | |
| # loop is already running. The following sequence is tried: MacOSX, Qt5Agg, Gtk3Agg, TkAgg, WxAgg, Agg. The last, Agg, is a non-interactive backend that can only write to files. It is used on Linux, if Matplotlib cannot connect to either an X display or a Wayland display. |
Sequence taken from matplotlibrc (I don't know if we check that somewhere else?
There was a problem hiding this comment.
looks good to me, took that with a very slight rewording.
$DISPLAY (or $WAYLAND_DISPLAY) is not the only thing we consider; we also check that one can indeed connect to the display server. (But there's no point of writing a full explanation of the Linux display protocols; there's much better docs for that elsewhere online.)
timhoffm
approved these changes
Jul 18, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
$DISPLAY (or $WAYLAND_DISPLAY) is not the only thing we consider; we
also check that one can indeed connect to the display server (#17396). (But
there's no point of writing a full explanation of the Linux display
protocols; there's much better docs for that elsewhere online.)
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).