Skip to content

Warn wayland users about napari crash#995

Draft
niksirbi wants to merge 1 commit into
mainfrom
document-wayland-bug
Draft

Warn wayland users about napari crash#995
niksirbi wants to merge 1 commit into
mainfrom
document-wayland-bug

Conversation

@niksirbi
Copy link
Copy Markdown
Member

@niksirbi niksirbi commented May 26, 2026

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other: docs

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 therefore movement) won't launch on such environments without a workaround:

The warning:

  • Includes a check for users to verify whether they are on wayland
  • Provides them with a workaround (setting 2 env variables)
  • Links to relevant napari issue and troubleshooting guide

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 in napari itself, instead of in every napari plugin, so I've proposed it to napari devs instead. If they implement that upstream, this warning can potentially be removed.

References

How has this PR been tested?

Local docs build, see preview below:

image

Is this a breaking change?

No.

Does this PR require an update to the documentation?

It is an update of docs.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@sonarqubecloud
Copy link
Copy Markdown

@niksirbi
Copy link
Copy Markdown
Member Author

Pausing this for a bit, because a fix might be merged upstream in napari: napari/napari#9009

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant