From 2c42904bf8f946182c671622d995f8991969b2eb Mon Sep 17 00:00:00 2001 From: Terry Gillis <40651217+harrmitch@users.noreply.github.com> Date: Wed, 16 Oct 2024 12:59:14 +0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: bbhtt --- docs/conventions.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/conventions.rst b/docs/conventions.rst index 2044abb6..00833a11 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -41,7 +41,7 @@ Here are some practical examples of poor ID choices: - ``org.example.desktop`` - This ID is problematic because the Appstream standard, for legacy reasons,treats IDs ending with + This ID is problematic because the Appstream standard, for legacy reasons, treats IDs ending with ``.desktop`` as a special case, leading to inconsistency. For the same reason, ``.Desktop`` suffixes should not be used for newly named applications. Don't hesitate to repeat the application name even if it is already part of the domain name section of the identifier (e.g. ``org.example.Example``). @@ -88,8 +88,8 @@ reference for providing MetaInfo. You can use the online `AppStream MetaInfo Creator `_ to generate a basic file. -MetaInfo files should be named using the application ID, end with the ``.metainfo.xml`` -file extension, and be placed in ``/app/share/metainfo/``. For example:: +MetaInfo files should be named using the application ID, must end with the ``.metainfo.xml`` +file extension, and must be placed in ``/app/share/metainfo/``. For example:: /app/share/metainfo/org.gnome.Dictionary.metainfo.xml @@ -142,8 +142,8 @@ information about each application. The `Freedesktop specification `_ provides a complete reference for writing desktop files. -Desktop files should be named using the application's ID, followed -by the ``.desktop`` file extension, and should be placed in +Desktop files must be named using the application's ID, followed +by the ``.desktop`` file extension, and must be placed in ``/app/share/applications/``. For example:: /app/share/applications/org.gnome.Dictionary.desktop @@ -252,5 +252,5 @@ and later. If your application needs to work on earlier versions of Flatpak, you the app will use the correct directory, even after Flatpak is later upgraded to version >1.13. -Also note that applications can be configured to use non-default base directory +Also, note that applications can be configured to use non-default base directory locations (see :doc:`sandbox-permissions`).