Gentle persons:

  I found one editorial issue reviewing the HTML files on 
http://www.linuxcnc.org/docs/2.5/ concerning the (English) Developer manual.

---
NML Messages (code/NML_Messages.html)

There are a number of lines that begin with double back-tics. For example,

---snip---
3.3. EMC_AXIS_SET_GAINS_TYPE

Description, NML Type: Set the PID gains, 103

Obs: currently not used in EMC2, needs to go to HAL

Written From: none

Read To: emctaskmain.cc

Parameter, Type: [axis (in EMC_AXIS_CMD_MSG), int]
` `[p, double] [i,double] [d, double]
` `[ff0, double] [ff1, double] [ff2, double]
` `[backlash, double] [bias, double] [maxError, double]
---snip---

I know squat about NML internals but it looks to me from the Asciidoc 
source that this may reflect some attempt to preserve indentation that 
was present in source code relating to NML. Does the result make sense 
to anyone?

I realize this is probably  the part of the EMC2 documentation least 
likely to be read by users who aren't already familiar with EMC2 
internals, but it seems to me it should be reformatted at some point.

And, yes, I realize the example I chose is marked as obsolete but it was 
just the first occurrence of this formatting  I came across.

Regards,
Kent


------------------------------------------------------------------------------
RSA(R) Conference 2012
Mar 27 - Feb 2
Save $400 by Jan. 27
Register now!
http://p.sf.net/sfu/rsa-sfdev2dev2
_______________________________________________
Emc-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/emc-developers

Reply via email to