Rendered ticket action hints don't end with a fullstop

[Alex Willmer <al.willmer@…>]

The default configuration of Trac trunk renders the hints for a ticket action without a trailing fullstop i.e.

The resolution will be set. Next status will be 'closed'

rather than

The resolution will be set. Next status will be 'closed'.

• ITicketActionController.render_ticket_action_control() documents a single hint should be returned for the action
• [ConfigurableTicketWorkflow.render_ticket_action_control() source:trunk/trac/ticket/default_workflow.py#L329​] joins it's multiple hints into one string by performing '. '.join(hints)
• [Ticket.html source:trunk/trac/ticket/templates/ticket.html#L316​] combines multiple hints (presumably in case more that one controller provides an action) by rendering each in a <span>

Ideally the displayed hint(s) would have a fullstop, since they're complete sentences. However ​th:XmlRpcPlugin currently joins the hints from multiple ITicketActionController by performing ". ".join(hints) + '.' - so having ConfigurableTicketWorkflow return "The resolution will be set. Next status will be 'closed'." would result in XmlRpcPlugin rendering a double fullstop.

[osimons]

Agree. This is not ideal. As you say, hints should be self-contained full sentences.

For ​th:XmlRpcPlugin it would be quite trivial to handle this - I can just add fullstop if one isn't present already.

PatchWelcome ;-)

[Christian Boos]

trac/ticket/default_workflow.py

@@ -326 +326 @@
         else:
             if status != '*':
                 hints.append(_("Next status will be '%(name)s'", name=status))
-        return (this_action['name'], tag(*control), '. '.join(hints))
+        return (this_action['name'], tag(*control), '. '.join(hints) + ".")
 
     def get_ticket_changes(self, req, ticket, action):
         this_action = self.actions[action]

seems preferable than having to go through all the hints, adding a "." there and then breaking all the translations for that…

[Christian Boos]

Applied in r11386.

[osimons]

All right. I've updated RPC plugin in ​th:changeset:12105 to support either behaviour.

[Christian Boos]

Unbelievable, such a small change and I got it wrong ;-)

The last dot should be added only when there are hints, of course. Thanks to Rémy for noticing!

[ethan.jucovy@…]

Replying to cboos:

Unbelievable, such a small change and I got it wrong ;-)

The last dot should be added only when there are hints, of course. Thanks to Rémy for noticing!

Here's a patch to stop the dot from showing up when there are no hints, like the "Leave" action which currently has a stray dot.

trac/ticket/default_workflow.py

@@ -326 +326 @@
         else:
             if status != '*':
                 hints.append(_("Next status will be '%(name)s'", name=status))
-        return (this_action['name'], tag(*control), '. '.join(hints) + ".")
+        return (this_action['name'], tag(*control), '. '.join(hints) + "." if hints else '')
 
     def get_ticket_changes(self, req, ticket, action):
         this_action = self.actions[action]

[Christian Boos]

Replying to ethan.jucovy@…:

Here's a patch to stop the dot from showing up when there are no hints, like the "Leave" action which currently has a stray dot.

Thanks Ethan, applied in r11703.