View Single Post
Old 07-10-2005, 09:31 AM   #1
rsperberg
Zealot
rsperberg began at the beginning.
 
rsperberg's Avatar
 
Posts: 114
Karma: 10
Join Date: Jun 2005
Location: NJ
Device: Kindle Voyage
Plucker documentation update

I'm moving this discussion of improving the documentation to a new thread.
Quote:
Roger:
What are the improved table-handling capabilities in the Python distiller?
Hacker:
Well, Plucker Desktop does not support tables (nor does JPluck or Sunrise), but the Python and C++ Plucker distillers do, when passed the --tables argument to the parsing commandline.
There are different ways we can handle this circumstance:
  • I can notify you by email that the documentation doesn't have anything about tables.
  • I (or anybody) can post a question in this forum and someone can sketch out an answer or point to a URI where the answer can/may be found.
If your grandmother is anything like me knowing that there is a --tables argument isn't enough to know what to do.

So I suggest that there be four levels in this documentation update:
  1. Simple identification of an error or omission or discrepancy between the program's behavior and the documentation or confusion about the program's operation
  2. Listing known differences between the latest version of the program and the documentation
  3. An explanation describing a new feature
  4. A complete segment suitable for adding to the public documentation
Personally, I'm only capable of steps 1 and 4, and I'm not yet knowledgeable to explore the program properly to do step 4 unless someone does step 3.

I guess I'm saying I need an education in the program before I can contribute in any substantive way, which inclines me towards using this forum to get steps 2 and 3 handled. I know you suggested sending email to you. Is there some alternative to piling more stuff in your inbox? I guess I'm thinking of how this might be handled in a wiki, though I'm not proposing setting up one.

Hm-m-m. Any other thoughts out there?

Roger
rsperberg is offline   Reply With Quote