Re: title caps and API documentation (was: English 101)

[David Castro <thejavaguy -at- gmail -dot- com>]

In my opinion, you absolutely need to use the correct capitalization
for the API call. I frequently check documentation just for the name
of a method that I know how to use, but have forgotten the name of. If
I go to the TOC to find it and see it capitalized at the beginning,
that's exactly how I'm going ot put it in my code, which will cause a
compiler error.

-David Castro
 thejavaguy -at- gmail -dot- com

On 5/23/05, Monica Cellio <cellio -at- pobox -dot- com> wrote:
> Sometimes, in programming
> guides (or discussions of examples), I have section headings that contain
> the names of functions that begin with lowercase letters.  It is
> technically incorrect (and misleading) to capitalize them, so if I'm using
> headline style I might end up with something like "Using refreshData under
> High Latency", which looks weird.

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

New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a 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.