RE: How would you handle this?

["Andrew Warren" <awarren -at- synaptics -dot- com>]

Jessica Weissman wrote:

> Below is an extract from some programmer-written documentation
> that I am assigned to clean up.
>
> [ The detail part of the choice type element contains a list
> of choices separated by the pipe ( | ) character.  Each choice
> consists of a number, an equality operator (which may be '#'
> for equals and '<' for greater than), and a format string. ]
> 
> Notice that at the end of the third line it says " and '<' for
> greater than".  Yes, it uses the lessthan sign for greater than.
> In defense of my colleague this is from the Java message spec.
> He did not implement it this way.    
> 
> What I've done is insert a footnote saying "This is not a
> misprint.  '<' really does mean 'greater than' here.  See
> [URL to java documentation page]  
> 
> Is this the best way?

Jessica:

In every less-than or greater-than comparison, there's one number that's
being tested for "less than the other" and one being tested for "greater
than the other".

The excerpt you provided doesn't mention the two operands of the
comparison, but I presume that they're describes somewhere... Can you
rework the explanation so it describes the "<" symbol as meaning "A is
less than B" rather than the current "B is greater than A"?

-Andrew

=== Andrew Warren  - awarren -at- synaptics -dot- com
=== Synaptics, Inc - Santa Clara, CA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -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.