RE: Do you spellcheck Code Comments

Subject: RE: Do you spellcheck Code Comments
From: John Posada <jposada01 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 12:24:34 -0700 (PDT)


Followup and conclusion: This was the message I sent to the developer
(who is in another state):

---------------
We've never spoken and I hate that the first time you are hearing
from me, it is in this way. I'm a technical writer working for xxx
(since mid-Feb) and right now I'm documenting the xxx.
Anyway, through meeting with xxx yesterday to discuss the xxx, I'm
documenting two SPs:
- xxx_SET
- xxx_GET
In extracting information on them, one of the things I'm pulling out
is Code Comments. After putting them in my document, I ran a spell
check and I came across this in the *_GET
"Exectute on all entities if no entity type specified"
I realize this is very minor, but I just figured I'd bring it to your
attention.
------------

This was his response:

-------------
Now that is what I call thorough! Thanks for picking up on that,
I'll make sure it is updated.
P.S. Nice to "meet" you!
Thanks again,
-------------

Ya never knows.



John Posada
Senior Technical Writer

?Never be afraid to try something new. Remember that a lone
amateur built the Ark. A large group of professionals built
the Titanic.? - Dave Barry

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

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Do you spellcheck Code Comments
Next by Author: Re: OOo Writer and FrontPage
Previous by Thread: RE: Do you spellcheck Code Comments
Next by Thread: Definition of "User-Friendly" Was Re: Engineering design practice


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

Sponsored Ads


Sponsored Ads