[interchange-docs] xmldocs - racke modified refs/dump.tag

[Kevin Walsh]

Davor Ocelic <docelic at hcoop.net> wrote:
> On Tue, Aug 14, 2007 at 10:04:23AM -0400, docs at icdevgroup.org wrote:
> 
> >  </row> 
> > @@ -26,14 +26,14 @@
> >  	<entry></entry>
> >  	<entry></entry>
> >  	<entry>0</entry>
> > -	<entry>Do not output &glos-environment; structure?</entry>
> > +	<entry>Exclude HTTP &glos-environment; variables.</entry>
> >  </row> 
> >  <row>
> 
> Oh, Racke, please don't do this type of changes.
> 
> For boolean options (yes,no), I always write the description in
> this form "<Question>?", and I always make it that "1" means
> yes and "0" means no.
> 
> Like, if option is "no_x", then my description is "Do not do X?",
> and if options "x", then my description is "Do X?".
> 
> You understand what I mean?
> 
I, for one, had no idea what you meant until you explained just now.

I thought that the question marks meant that you were unsure about
the text and were making placeholders for later confirmation.
I.e. you were asking the reader to confirm it all.

My response to "Do not output &glos-environment; structure?", in that
context, tends to be "are you asking me or telling me?"  Docs should
be telling me.

>
> This is consistent accross all xmldocs, please revert the two
> changes back, or I'll do it when I get some time for xmldocs again.
> 
Or (preferably) change the rest of the text so that some other wording
is consistent.

-- 
   _/   _/  _/_/_/_/  _/    _/  _/_/_/  _/    _/
  _/_/_/   _/_/      _/    _/    _/    _/_/  _/   K e v i n   W a l s h
 _/ _/    _/          _/ _/     _/    _/  _/_/    kevin at cursor.biz
_/   _/  _/_/_/_/      _/    _/_/_/  _/    _/