Inconsistancy in ending sentance in doc description

Bug #1226841 reported by Sahdev Zala
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Low
Sahdev Zala

Bug 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.

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.

Sahdev Zala (spzala)
description: updated
Steven Hardy (shardy)
Changed in heat:
milestone: none → icehouse-1
status: New → Triaged
importance: Undecided → Low
Sahdev Zala (spzala)
Changed in heat:
assignee: nobody → Sahdev Zala (spzala)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

Fix proposed to branch: master
Review: https://review.openstack.org/53006

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/53006
Committed: http://github.com/openstack/heat/commit/bf465d2d0df44b4f163ba9c73c6b0222804b54bc
Submitter: Jenkins
Branch: master

commit bf465d2d0df44b4f163ba9c73c6b0222804b54bc
Author: Sahdev Zala <email address hidden>
Date: Mon Oct 21 14:53:46 2013 -0500

    End doc sentences in a consistent way

    During the doc review for resources we decided to go with the convention
    of ending sentences with full-stop. This patch takes care of few missing
    places.

    Close-bug: #1226841

    Change-Id: I18ccc6b20273d44b3378e9ffa35515976eda1b32

Angus Salkeld (asalkeld)
Changed in heat:
status: Triaged → Fix Committed
Thierry Carrez (ttx)
Changed in heat:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: icehouse-1 → 2014.1
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.