go_away

Author Topic: Error in Webbot lib documentation  (Read 1115 times)

0 Members and 1 Guest are viewing this topic.

Offline chelmiTopic starter

  • Supreme Robot
  • *****
  • Posts: 496
  • Helpful? 15
Error in Webbot lib documentation
« on: March 14, 2010, 04:47:45 PM »
Hi guys,

I'm adding a LCD to my bot (20x4 parallel) and I noticed a mistake in the Webbot doc.
In the display section, the part regarding writer initialization is:

Code: [Select]
Writer(myDisplay_put_char){
   displaySendByte(&myDisplay, byte);
}

where it should be

Code: [Select]
MAKE_WRITER(myDisplay_put_char){
   displaySendByte(&myDisplay, byte);
}

Otherwise it works faultlessly, as usual. Great work Webbot!

Chelmi.

Offline chelmiTopic starter

  • Supreme Robot
  • *****
  • Posts: 496
  • Helpful? 15
Re: Error in Webbot lib documentation
« Reply #1 on: March 14, 2010, 05:03:45 PM »
actually it should probably be:

Code: [Select]
MAKE_WRITER(myDisplay_put_char){
   return displaySendByte(&myDisplay, byte);
}

to get rid off the warning.

Offline Webbot

  • Expert Roboticist
  • Supreme Robot
  • *****
  • Posts: 2,150
  • Helpful? 109
Re: Error in Webbot lib documentation
« Reply #2 on: March 14, 2010, 05:35:11 PM »
Chelmi - thanks for the 'heads up' - I'll take a look at the docs for the next release.

Just for info:-
Reporting documentation errors via this forum is fine - but I'd prefer them as emails or PMs.
Why?  Well these forum threads hang around for years after the docs have been fixed and don't xref any version/release of the docs so kinda act as fog in the longer term.
I also sometimes get some 'reports' which are actually wrong - and this then acts as negative documentation in the future.


Thanks for the observation.
Webbot Home: http://webbot.org.uk/
WebbotLib online docs: http://webbot.org.uk/WebbotLibDocs
If your in the neighbourhood: http://www.hovinghamspa.co.uk

Offline chelmiTopic starter

  • Supreme Robot
  • *****
  • Posts: 496
  • Helpful? 15
Re: Error in Webbot lib documentation
« Reply #3 on: March 14, 2010, 06:03:17 PM »
Ok Webbot,

I wasn't sure of the popper "procedure" and figured the info could be useful to somebody else.
But you remark makes sense and I'll modify this thread after the next release.

Chelmi.

 


Get Your Ad Here