Re: Comma question

Subject: Re: Comma question
From: Karen Felker <akaren -at- earthlink -dot- net>
To: Tony Chung <tonyc -at- tonychung -dot- ca>
Date: Fri, 19 Jul 2013 10:25:55 -0700

Yes, Tony, I failed to mention that this text is in the second column of a reference table. The first column lists the algorithm names; the second column briefly describes the algorithm behaviors.

Karen

My actions are my only true belongings- Thich Nhat Hanh





On Jul 19, 2013, at 10:06 AM, Tony Chung wrote:

> Hi Karen,
>
> It doesn't help that you don't have a complete sentence. A missing subject can cloud anyone's perception of how the language is used.. While this style is common in API docs, just know that the comma rules should technically follow a proper sentence structure.
>
> Your comma placement with subject added:
> {The shplee method} assigns numbers to actors and events, based on natural groups called clusters.
>
> Your alternate suggestion:
> {The shplee method} assigns numbers, based on natural groups called clusters, to actors and events.
>
> Your alternate alternate suggestion:
> {The shplee method} assigns numbers to actors and events. The numbers are based on natural groups called clusters.
>
>
> Your alternate suggestion works because the clause modifies "numbers" instead of the "actors and events".
>
> My preference is your alternate alternate suggestion, primarily for clarity and plain language. The short sentences will aid translation or interpretation by non-English speakers.
>
> -Tony
>
>
>



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Comma question: From: Karen Felker
Re: Comma question: From: Tony Chung

Previous by Author: Comma question
Next by Author: Re: Comma question
Previous by Thread: Re: Comma question
Next by Thread: RE: Comma question


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads