diff mbox series

l10n: README: call more attention to plural strings

Message ID 25107068cbbf8c9ce6886e66e25dff19e072583f.1639425295.git.steadmon@google.com (mailing list archive)
State Superseded
Headers show
Series l10n: README: call more attention to plural strings | expand

Commit Message

Josh Steadmon Dec. 13, 2021, 7:56 p.m. UTC
In po/README.md, we point core developers to gettext's "Preparing
Strings" documentation for advice on marking strings for translation.
However, this doc doesn't really discuss the issues around plural form
translation, which can make it seem that nothing special needs to be
done in this case.

Add a specific callout here about marking plural-form strings so that
the advice later on in the README is not overlooked.

Signed-off-by: Josh Steadmon <steadmon@google.com>
---
 po/README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)


base-commit: cd3e606211bb1cf8bc57f7d76bab98cc17a150bc

Comments

Junio C Hamano Dec. 13, 2021, 9:56 p.m. UTC | #1
Josh Steadmon <steadmon@google.com> writes:

> In po/README.md, we point core developers to gettext's "Preparing
> Strings" documentation for advice on marking strings for translation.
> However, this doc doesn't really discuss the issues around plural form
> translation, which can make it seem that nothing special needs to be
> done in this case.
>
> Add a specific callout here about marking plural-form strings so that
> the advice later on in the README is not overlooked.
>
> Signed-off-by: Josh Steadmon <steadmon@google.com>
> ---
>  po/README.md | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/po/README.md b/po/README.md
> index dcd8436c25..fd1e024dd3 100644
> --- a/po/README.md
> +++ b/po/README.md
> @@ -219,7 +219,10 @@ General advice:
>    they're part of Git's API.
>  
>  - Adjust the strings so that they're easy to translate. Most of the
> -  advice in `info '(gettext)Preparing Strings'` applies here.
> +  advice in `info '(gettext)Preparing Strings'` applies here. Strings
> +  referencing numbers of items may need to be split into singular and
> +  plural forms; see the Q\_() wrapper in the C sub-section below for an
> +  example.
>  
>  - If something is unclear or ambiguous you can use a "TRANSLATORS"
>    comment to tell the translators what to make of it. These will be

Sounds good to me, but I'd want an ack by those from the l10n
department.

Thanks.
Josh Steadmon Dec. 13, 2021, 10:02 p.m. UTC | #2
On 2021.12.13 13:56, Junio C Hamano wrote:
> Josh Steadmon <steadmon@google.com> writes:
> 
> > In po/README.md, we point core developers to gettext's "Preparing
> > Strings" documentation for advice on marking strings for translation.
> > However, this doc doesn't really discuss the issues around plural form
> > translation, which can make it seem that nothing special needs to be
> > done in this case.
> >
> > Add a specific callout here about marking plural-form strings so that
> > the advice later on in the README is not overlooked.
> >
> > Signed-off-by: Josh Steadmon <steadmon@google.com>
> > ---
> >  po/README.md | 5 ++++-
> >  1 file changed, 4 insertions(+), 1 deletion(-)
> >
> > diff --git a/po/README.md b/po/README.md
> > index dcd8436c25..fd1e024dd3 100644
> > --- a/po/README.md
> > +++ b/po/README.md
> > @@ -219,7 +219,10 @@ General advice:
> >    they're part of Git's API.
> >  
> >  - Adjust the strings so that they're easy to translate. Most of the
> > -  advice in `info '(gettext)Preparing Strings'` applies here.
> > +  advice in `info '(gettext)Preparing Strings'` applies here. Strings
> > +  referencing numbers of items may need to be split into singular and
> > +  plural forms; see the Q\_() wrapper in the C sub-section below for an
> > +  example.
> >  
> >  - If something is unclear or ambiguous you can use a "TRANSLATORS"
> >    comment to tell the translators what to make of it. These will be
> 
> Sounds good to me, but I'd want an ack by those from the l10n
> department.
> 
> Thanks.

Hmm, I meant to CC both Jiang and Bagas, not sure why it didn't go
through.
Junio C Hamano Dec. 13, 2021, 10:18 p.m. UTC | #3
Josh Steadmon <steadmon@google.com> writes:

> On 2021.12.13 13:56, Junio C Hamano wrote:
>> Josh Steadmon <steadmon@google.com> writes:
>> 
>> > In po/README.md, we point core developers to gettext's "Preparing
>> > Strings" documentation for advice on marking strings for translation.
>> > However, this doc doesn't really discuss the issues around plural form
>> > translation, which can make it seem that nothing special needs to be
>> > done in this case.
>> >
>> > Add a specific callout here about marking plural-form strings so that
>> > the advice later on in the README is not overlooked.
>> >
>> > Signed-off-by: Josh Steadmon <steadmon@google.com>
>> > ---
>> >  po/README.md | 5 ++++-
>> >  1 file changed, 4 insertions(+), 1 deletion(-)
>> >
>> > diff --git a/po/README.md b/po/README.md
>> > index dcd8436c25..fd1e024dd3 100644
>> > --- a/po/README.md
>> > +++ b/po/README.md
>> > @@ -219,7 +219,10 @@ General advice:
>> >    they're part of Git's API.
>> >  
>> >  - Adjust the strings so that they're easy to translate. Most of the
>> > -  advice in `info '(gettext)Preparing Strings'` applies here.
>> > +  advice in `info '(gettext)Preparing Strings'` applies here. Strings
>> > +  referencing numbers of items may need to be split into singular and
>> > +  plural forms; see the Q\_() wrapper in the C sub-section below for an
>> > +  example.
>> >  
>> >  - If something is unclear or ambiguous you can use a "TRANSLATORS"
>> >    comment to tell the translators what to make of it. These will be
>> 
>> Sounds good to me, but I'd want an ack by those from the l10n
>> department.
>> 
>> Thanks.
>
> Hmm, I meant to CC both Jiang and Bagas, not sure why it didn't go
> through.

That's OK.  We watch each other's back ;-)
Jiang Xin Dec. 16, 2021, 1:10 a.m. UTC | #4
On Tue, Dec 14, 2021 at 6:02 AM Josh Steadmon <steadmon@google.com> wrote:
>
> On 2021.12.13 13:56, Junio C Hamano wrote:
> > Josh Steadmon <steadmon@google.com> writes:
> >
> > > In po/README.md, we point core developers to gettext's "Preparing
> > > Strings" documentation for advice on marking strings for translation.
> > > However, this doc doesn't really discuss the issues around plural form
> > > translation, which can make it seem that nothing special needs to be
> > > done in this case.
> > >
> > > Add a specific callout here about marking plural-form strings so that
> > > the advice later on in the README is not overlooked.
> > >
> > > Signed-off-by: Josh Steadmon <steadmon@google.com>
> > > ---
> > >  po/README.md | 5 ++++-
> > >  1 file changed, 4 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/po/README.md b/po/README.md
> > > index dcd8436c25..fd1e024dd3 100644
> > > --- a/po/README.md
> > > +++ b/po/README.md
> > > @@ -219,7 +219,10 @@ General advice:
> > >    they're part of Git's API.
> > >
> > >  - Adjust the strings so that they're easy to translate. Most of the
> > > -  advice in `info '(gettext)Preparing Strings'` applies here.
> > > +  advice in `info '(gettext)Preparing Strings'` applies here. Strings
> > > +  referencing numbers of items may need to be split into singular and
> > > +  plural forms; see the Q\_() wrapper in the C sub-section below for an
> > > +  example.

Wouldn't it be better if we add a new rule ("Strings ... an example.")
after this one?

> > >
> > >  - If something is unclear or ambiguous you can use a "TRANSLATORS"
> > >    comment to tell the translators what to make of it. These will be
> >
> > Sounds good to me, but I'd want an ack by those from the l10n
> > department.
> >
> > Thanks.
>
> Hmm, I meant to CC both Jiang and Bagas, not sure why it didn't go
> through.

Yesterday I was interrupted by a meeting while reading this thread.

--
Jiang Xin
Josh Steadmon Dec. 21, 2021, 7:01 p.m. UTC | #5
On 2021.12.16 09:10, Jiang Xin wrote:
> On Tue, Dec 14, 2021 at 6:02 AM Josh Steadmon <steadmon@google.com> wrote:
> >
> > On 2021.12.13 13:56, Junio C Hamano wrote:
> > > Josh Steadmon <steadmon@google.com> writes:
> > >
> > > > In po/README.md, we point core developers to gettext's "Preparing
> > > > Strings" documentation for advice on marking strings for translation.
> > > > However, this doc doesn't really discuss the issues around plural form
> > > > translation, which can make it seem that nothing special needs to be
> > > > done in this case.
> > > >
> > > > Add a specific callout here about marking plural-form strings so that
> > > > the advice later on in the README is not overlooked.
> > > >
> > > > Signed-off-by: Josh Steadmon <steadmon@google.com>
> > > > ---
> > > >  po/README.md | 5 ++++-
> > > >  1 file changed, 4 insertions(+), 1 deletion(-)
> > > >
> > > > diff --git a/po/README.md b/po/README.md
> > > > index dcd8436c25..fd1e024dd3 100644
> > > > --- a/po/README.md
> > > > +++ b/po/README.md
> > > > @@ -219,7 +219,10 @@ General advice:
> > > >    they're part of Git's API.
> > > >
> > > >  - Adjust the strings so that they're easy to translate. Most of the
> > > > -  advice in `info '(gettext)Preparing Strings'` applies here.
> > > > +  advice in `info '(gettext)Preparing Strings'` applies here. Strings
> > > > +  referencing numbers of items may need to be split into singular and
> > > > +  plural forms; see the Q\_() wrapper in the C sub-section below for an
> > > > +  example.
> 
> Wouldn't it be better if we add a new rule ("Strings ... an example.")
> after this one?

Fixed in V2, thanks!
diff mbox series

Patch

diff --git a/po/README.md b/po/README.md
index dcd8436c25..fd1e024dd3 100644
--- a/po/README.md
+++ b/po/README.md
@@ -219,7 +219,10 @@  General advice:
   they're part of Git's API.
 
 - Adjust the strings so that they're easy to translate. Most of the
-  advice in `info '(gettext)Preparing Strings'` applies here.
+  advice in `info '(gettext)Preparing Strings'` applies here. Strings
+  referencing numbers of items may need to be split into singular and
+  plural forms; see the Q\_() wrapper in the C sub-section below for an
+  example.
 
 - If something is unclear or ambiguous you can use a "TRANSLATORS"
   comment to tell the translators what to make of it. These will be