[OpenStack-docs] Code block in RST and translation

Pančur, Matjaž Matjaz.Pancur at fri.uni-lj.si
Wed Nov 25 07:47:33 UTC 2015


> On 25 Nov 2015, at 03:41, KATO Tomoyuki <tomo at dream.daynight.jp> wrote:
> 
>> My idea at now is to use "code-block" directive as possible as we can,
> 
> As far as I know, docs team guides mainly use "code-block".
> So, I'm okay to unify to "code-block" directive.
> 
>> but I am not sure it is the right direction as "::" is widely used.
> 
> In my understand, most of developers like “::”, which is simple RST format :)

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.

Matjaz


>> Thought?
>> 
>> Thanks,
>> Akihiro
>> 
>> [1] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html
>> [2] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html#standard-literal-block
>> [3] http://docs.openstack.org/contributor-guide/index.html#search-in-this-guide
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



More information about the OpenStack-docs mailing list