| 2013-09-18 16:00:23 |
Sahdev Zala |
description |
I have been reviewing doc patches and noticed that in some we have sentence(s) ended with full-stop and some not. Also, I could not find any guideline on when to use full-stop, something that can help while reviewing. I would prefer to use full-stop.
You can see the inconsistency, http://docs-draft.openstack.org/19/46219/5/check/gate-heat-docs/5c53dbc/doc/build/html/template_guide/openstack.html#
(thanks to Steve Baker for the doc link)
After discussion with Steve Baker, opening this bug for tracking. |
I have been reviewing doc patches and noticed that in some we have sentence(s) ended with full-stop and some not. Also, I could not find any guideline on when to use full-stop, something that can help while reviewing. I would prefer to use full-stop.
You can see the inconsistency, http://docs-draft.openstack.org/19/46219/5/check/gate-heat-docs/5c53dbc/doc/build/html/template_guide/openstack.html#
(thanks to Steve Baker for the doc link)
After discussion with Steve Baker, opening this bug for tracking.
We are currently reviewing new patches with this convention of ending sentences with full-stop. We may want to make changes to old docs in future where it's needed. |
|
