1275614 - aboutdebugging: Add localization comments to aboutdebugging.properties

Status: RESOLVED FIXED

(DevTools :: about:debugging, defect, P3)

Description

[Julian Descottes [:jdescottes]]

At the moment all strings localized through aboutdebugging.properties are missing comments. This will make it harder for localization teams to handle the translation.

See https://dxr.mozilla.org/mozilla-central/source/devtools/client/locales/en-US/aboutdebugging.properties

Comment 1

[Julian Descottes [:jdescottes]]

Jan: Just want to confirm we're on the same page here. Is there a reason why we don't have localization notes for now?

Comment 2

[Jan Keromnes [:janx]]

Julian, I agree that we should have localization comments if they're helpful to localizers.

They're absent from aboutdebugging.properties simply because we forgot them originally, and new contributions stayed consistent with that.

Pike, do you have any guidelines on when/how to write useful localization notes next to our strings?

Comment 3

[Francesco Lodolo [:flod]]

You can find some information in this page (together with a lot of other useful information about l10n)
https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_content_best_practices#Add_localization_notes

about:debugging is a very self-contained window, so it's quite easy to figure out where strings go through testing.

The only string that really needs a comment is doesNotExist, to explain what the variable is, and maybe the first three strings to explain that they are button labels.

Comment 4

[Jan Keromnes [:janx]]

Thanks Francesco! Julian, are you interested in mentoring this bug e.g. as a [good first bug]?

Comment 5

[Julian Descottes [:jdescottes]]

(In reply to Jan Keromnes [:janx] from comment #4)
> Thanks Francesco! Julian, are you interested in mentoring this bug e.g. as a
> [good first bug]?

Sure! As explained in the comments above the goal of this bug will be to add localization notes to some of the keys defined in: devtools/client/locales/en-US/aboutdebugging.properties. 

Keys that should be documented in priority:
- doesNotExist: error message displayed when navigating to an invalid aboutdebugging page (the variable is the invalid page name) 
- debug: label of the button that starts debugging a service worker 
- push: label of the button that pushes a test payload to a service worker
- start: label of the button that starts a service worker

The usual syntax used for localization comments can be found in other properties files from the same folder, such as animationinspector.properties.

Documentation for contributors can be found at: https://wiki.mozilla.org/DevTools/Hacking

Comment 6

[Dalimil Hajek [:dalimil]]

Attachment: rev1

I added the localization strings

Comment 7

[Julian Descottes [:jdescottes]]

Comment on attachment 8769482 [details] [diff] [review]
rev1

Review of attachment 8769482 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks a lot for working on this Dalimil! 

The changeset looks good, hopefully I can convince you to document two other strings in the file, which feel a bit ambiguous to me without any description.
Let me know if you need help with any of them!

Also an overall nit: can you add a dot at the end of each documentation sentence?

Finally when you amend your commit, can you update the message so that it ends with r=jdescottes (no need for "Julian Descottes [:jdescottes]").

Thanks!

::: devtools/client/locales/en-US/aboutdebugging.properties
@@ +2,5 @@
>  # License, v. 2.0. If a copy of the MPL was not distributed with this
>  # file, You can obtain one at http://mozilla.org/MPL/2.0/.
>  
> +# LOCALIZATION NOTE (debug):
> +# This string is displayed as a label of the button that starts 

nit: remove the trailing space here.

@@ +50,2 @@
>  extensions = Extensions
>  selectAddonFromFile2 = Select Manifest File or Package (.xpi)

Let's also document this one: this is the title of the file picker displayed when the user clicks on "load temporary add on"

@@ +55,4 @@
>  reload = Reload
> +
> +# LOCALIZATION NOTE (reloadDisabledTooltip):
> +# This string is displayed in a tooltip that appears when hovering over a 

nit: remove the trailing space

@@ +72,3 @@
>  tabs = Tabs
>  
>  pageNotFound = Page not found

Let's document this one as well since it's directly connected to the next one. This one is the main message displayed on any error/invalid page.

Comment 8

[Dalimil Hajek [:dalimil]]

Attachment: rev2

OK, fixed.

Comment 9

[Julian Descottes [:jdescottes]]

Comment on attachment 8770023 [details] [diff] [review]
rev2

Review of attachment 8770023 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks for addressing the nits, the patch is ready to go.

I'll add the checkin-needed flag so that it can be picked up by one of the sheriffs, who will land it on fx-team.
In case you want to find other devtools bugs, you can have a look at http://firefox-dev.tools/ :)

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/fx-team/rev/a53b203b8cba
aboutdebugging: Add localization comments to aboutdebugging.properties. r=jdescottes

Comment 11

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/a53b203b8cba