Warn wayland users about napari crash#995
Draft
niksirbi wants to merge 1 commit into
Draft
Conversation
|
Member
Author
|
Pausing this for a bit, because a fix might be merged upstream in |
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
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.



Description
What is this PR
Why is this PR needed?
Closes 983.
What does this PR do?
Add a warning to the installation guide (in the "Verify the installation" section), targeted to Linux users with wayland-based desktop environments.
napari(and thereforemovement) won't launch on such environments without a workaround:The warning:
We also considered an alternative, i.e. to automatically detect wayland and set the env variables accordingly in
cli_entrypoint.py, as in ethograph: Akseli-Ilmanen/ethograph#1 (comment). But that fix feels like it belongs innapariitself, instead of in everynapariplugin, so I've proposed it tonaparidevs instead. If they implement that upstream, this warning can potentially be removed.References
movementfails to launch on Ubuntu (Gnome on wayland) #983napariv7 launching issues napari/napari#8808How has this PR been tested?
Local docs build, see preview below:
Is this a breaking change?
No.
Does this PR require an update to the documentation?
It is an update of docs.
Checklist: