Hi,

brlcad has left the following comment at Write manual page documentation (for g-dot) http://www.google-melange.com/gci/task/view/google/gci2014/6423086379302912:


good start


This is a really good start and you seem to have all of the requisite sections. However, your documentation is a little thin. At a minimum, you should have at least reported what the DOT format is for/from. What purpose does it serve? Hint: see the header of src/conv/g-dot.c and read about Graphviz.

Also noticed that the usage statement indicates the .g file argument is optional (it is not).

Did you test adding this documentation to the CMakeLists.txt file and compiling it into html to make sure there are no errors?

You can run these after editing it and submit the resulting my_g_dot_changes.patch file:

svn add doc/docbook/system/man1/en/g-dot.xml

svn diff doc/docbook > my_g_dot_changes.patch


Greetings,
The Google Open Source Programs Team


---
You are receiving this message because you are subscribed to Write manual page documentation (for g-dot). To stop receiving these messages, go to: http://www.google-melange.com/gci/task/view/google/gci2014/6423086379302912.

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=164703151&iu=/4140/ostg.clktrk
_______________________________________________
BRL-CAD Tracker mailing list
brlcad-tracker@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/brlcad-tracker

Reply via email to