<div dir="ltr">Based on experience with the installation and networking guides that contain a variety of these blocks, using :: instead of an explicit code-block tends to cause strange rendering issues with certain content.</div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Nov 27, 2015 at 8:38 AM, Akihiro Motoki <span dir="ltr"><<a href="mailto:amotoki@gmail.com" target="_blank">amotoki@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Do we have an agreement?<br>
If so, we would like to change the corresponding section in the<br>
Documentation Contributor Guide [1].<br>
<br>
BTW, why is '::' at the end of line called 'Standard literal block' and<br>
is 'code-block' directive called 'Non-Standard'?<br>
Is it because '::' is a common convention used in RST format and<br>
'code-block' is from Sphinx?<br>
<br>
[1] <a href="http://docs.openstack.org/contributor-guide/rst-conv/source-code.html" rel="noreferrer" target="_blank">http://docs.openstack.org/contributor-guide/rst-conv/source-code.html</a><br>
<br>
Akihiro<br>
<div><div class="h5"><br>
2015-11-26 7:31 GMT+09:00 KATO Tomoyuki <<a href="mailto:tomo@dream.daynight.jp">tomo@dream.daynight.jp</a>>:<br>
>> On 2015-11-25 15:48, KATO Tomoyuki wrote:<br>
>> >><br>
>> >>> On 25 Nov 2015, at 03:41, KATO Tomoyuki <<a href="mailto:tomo@dream.daynight.jp">tomo@dream.daynight.jp</a>> wrote:<br>
>> >>><br>
>> >>>> My idea at now is to use "code-block" directive as possible as we can,<br>
>> >>><br>
>> >>> As far as I know, docs team guides mainly use "code-block".<br>
>> >>> So, I'm okay to unify to "code-block" directive.<br>
>> >>><br>
>> >>>> but I am not sure it is the right direction as "::" is widely used.<br>
>> >>><br>
>> >>> In my understand, most of developers like “::”, which is simple RST format :)<br>
>> >><br>
>> >> Maybe we could add a gate check that looks for “::” in the end of the strings (original and translated)? It would enable developers to use whatever they are used to.<br>
>> ><br>
>> > Nice idea! Sounds good to me, as a non-vote job.<br>
>> ><br>
>> > Regards,<br>
>> > KATO Tomoyuki<br>
>><br>
>> But who will monitor this and correct it?<br>
>><br>
>> We already see warnings in translated code that everybody ignores, let's<br>
>> find a good way to monitor and fix these problems first before we add<br>
>> more tests...<br>
><br>
> When I heard the idea, I thinked it's a job, like "checkniceness-2",<br>
> that simply checks syntax of the code, not a job builds translated documents.<br>
> So, the patch submitter and reviewers can easily check the result.<br>
><br>
> For example, when FAIL(non-voting),<br>
><br>
>  Line xx: found the usge of :: directive,<br>
>  This style is harded for translators to traslate than code-block.<br>
>  We recommend use code-block directive instead of :: directive....<br>
><br>
> KATO<br>
><br>
>><br>
>> Andreas<br>
>> --<br>
>>  Andreas Jaeger aj@{<a href="http://suse.com" rel="noreferrer" target="_blank">suse.com</a>,<a href="http://opensuse.org" rel="noreferrer" target="_blank">opensuse.org</a>} Twitter: jaegerandi<br>
>>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
>>    GF: Felix Imendörffer, Jane Smithard, Graham Norton,<br>
>>        HRB 21284 (AG Nürnberg)<br>
>>     GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<br>
>><br>
>><br>
><br>
</div></div>> _______________________________________________<br>
> Openstack-i18n mailing list<br>
> <a href="mailto:Openstack-i18n@lists.openstack.org">Openstack-i18n@lists.openstack.org</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n</a><br>
<div class="HOEnZb"><div class="h5">><br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</div></div></blockquote></div><br></div>