Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added notes section to app documentation to include note about title … #2255

Merged
merged 4 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/2255.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Some limitations on App presentation imposed by Wayland have been documented.
10 changes: 10 additions & 0 deletions docs/reference/api/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ details, along with many of the other constructor arguments, as packaging metada
format compatible with :any:`importlib.metadata`. If you deploy your app with `Briefcase
<https://briefcase.readthedocs.io/en/stable>`__, this will be done automatically.

Notes
-----

* Apps executed under Wayland on Linux environment may not show the app's formal name
correctly. Wayland considers many aspects of app operation to be the domain of the
windowing environment, not the app; as a result, some API requests will be ignored
under a Wayland environment. Correctly displaying the app's formal name requires the
use of a desktop metadata that Wayland can read. Packaging your app with `Briefcase
<https://briefcase.readthedocs.io/en/stable>`__ is one way to produce this metadata.

Reference
---------

Expand Down
1 change: 1 addition & 0 deletions docs/spelling_wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Ventura
verbing
viewport
watchOS
Wayland
WebKit
whitespace
Winforms