[OpenStack-docs] [Contributor Guide] RST inline markup for application and command

Anne Gentle annegentle at justwriteclick.com
Wed Nov 18 15:26:24 UTC 2015


On Wed, Nov 18, 2015 at 9:15 AM, KATO Tomoyuki <tomo at dream.daynight.jp>
wrote:

> Hi team,
>
> We have RST inline markup conventions for application and command [1].
> On the other hand, we decided to use `` (double backticks) for file name
> and path.
> For simplicity... easy to learn for new comer... view at GitHub......
> (:file:` ` is not a first recommendation, but acceptable.)
>
>
I believe these are for translation purposes, so you cannot change that
convention without consulting with the i18N team first. Have you gotten
sign-off from that team for this change?

Also by submitting this change are you also going to change all existing
docs?

Thanks,
Anne


> I would like to use `` (double backticks) for application and command
> for consistency and simplicity. I submitted the change request [2].
>
> Thought?
>
> [1]
> http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html#application
> [2] https://review.openstack.org/#/c/246972/
>
> Best Regards,
> KATO Tomoyuki
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151118/efcdc113/attachment.html>


More information about the OpenStack-docs mailing list