Open Stack

Several projects recently enhanced the help text for configuration
options.  In Glance, this has resulted in strings like [0] (and there
are lots of other examples in that file).

For those strings, the exact formatting isn't essential, but the
paragraphing and bulleted lists are important.

My question is whether having this text in a single block of
triple-quotes (as it is now) is useful to translators (so you can see
the entire context), or whether there's a way you'd prefer it to be
broken up so that it works better with Zanata.

When we added all these blocks of text in Newton, we were focused on
making things easier for operators, and didn't realize that it would
cause problems for translators ... sorry about that!

thanks,
brian


[0]
https://github.com/openstack/glance/blob/6b72fc3ef242f8572a581a09d082fd29f5656dd0/glance/common/config.py#L254-L286


On 12/5/16 5:28 AM, Robert Simai wrote:
> Hi,
> 
> I guess everyone translating has seen this,
>     sometimes there's source text formatted
>     by line breaks and even spaces at the
>     beginning of lines which finally forces
>     the translator to keep this format, else
>     Zanata wouldn't allow to save it.
> 
> For an example, see above :-)
> 
> I think this formatting is rather bad and shouldn't happen. Text should be 
> either continuous or it needs to be split to go into multiple strings.
> 
> Are there any reasons where as such formatted text is justified, translator 
> should leave it as it is?
> 
> Or shall we rather rather flag this through a bug, or even create patches to 
> change it?
> 
> Opinions?
>