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

Documenation: Addons example metadata has <id> pattern not following recommendation #197

Closed
kossebau opened this issue Aug 10, 2018 · 1 comment

Comments

@kossebau
Copy link

In section "2.6.2. Example file" of the AppStream documentation this example id is given:

<id>org.gnome.gedit-code-assistance</id>

Which gives a bad example though, as section "2.1.3. XML Specification" has a note "Escaping characters in the component ID" which recommends "to replace any hyphens in the ID with underscores".

If being inspired by the example only, then appstreamcli complaining about such hyphens, results in developers rolling theirs eyes unwantedly, which can be harmful ;)

@ximion
Copy link
Owner

ximion commented Aug 13, 2018

results in developers rolling theirs eyes unwantedly, which can be harmful

Depends on how much force they use when rolling their eyes...

I thought I caught all the occurences of dashes in the docs, looks like I missed some... The "no hyphen" requirement was added to AppStream at a later time, so some IDs haven't been updated yet.

@ximion ximion closed this as completed in 274d756 Oct 21, 2018
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

No branches or pull requests

2 participants