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

Conversation

LunaMeadows
Copy link
Contributor

Added notes section to app documentation to include note about title bar name not displaying properly on gnome wayland when ran with briefcase dev or python -m

Adds important information for app devs to curb troubleshooting known issues

Fixes #1862

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

…bar name not displaying properly on gnome wayland when ran with briefcase dev or python -m
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've provided a suggested rewording for grammar purposes; there's also a missing changenote, and you'll need to add Wayland to the spell check dictionary. You can check the operation of the spell checker with tox -e docs-lint.

Comment on lines 76 to 79
* Apps ran in a Gnome Wayland environment with python -m or briefcase dev will not show
the formal app name in the title bar. In order to make the title show properly, you
will need to build or package your app with `Briefcase
<https://briefcase.readthedocs.io/en/stable>`__.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Apps ran in a Gnome Wayland environment with python -m or briefcase dev will not show
the formal app name in the title bar. In order to make the title show properly, you
will need to build or package your app with `Briefcase
<https://briefcase.readthedocs.io/en/stable>`__.
* 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 ingored
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.

…bar name not displaying properly on gnome wayland when ran with briefcase dev or python -m
…bar name not displaying properly on gnome wayland when ran with briefcase dev or python -m
@@ -0,0 +1 @@
Documentation note about Wayland compatability for app title added
Copy link
Member

@freakboy3742 freakboy3742 Dec 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change notes should be framed as potential release notes:

Suggested change
Documentation note about Wayland compatability for app title added
Some limitations on App presentation imposed by Wayland have been documented.

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update!

@freakboy3742 freakboy3742 merged commit 6c71478 into beeware:main Dec 4, 2023
35 checks passed
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.

Application title isn't reported correctly under Wayland
2 participants