Engine needs more documentation

Question

Engine needs more documentation

becega opened this issue 10 years ago · comments

There is no documentation on the engine or in the VIs on the engine. WHne Chriss was trying to understand how the engine worked he mentioned there is no documentation on it. @Beazurt

smithed commented 9 years ago

yay

Beazurt · Answer 1 · Mon Dec 08 2014 23:53:06 GMT+0800 (China Standard Time)

I added VI documentation to the standard engine VI and most of its most important subVIs. I wouldn't say the documentation is excellent yet, so I will leave this issue open, but I think it is in a much better spot now.

smithed · Answer 2 · Fri Jan 23 2015 09:27:17 GMT+0800 (China Standard Time)

now needs even more

smithed · Answer 3 · Thu Mar 05 2015 10:24:43 GMT+0800 (China Standard Time)

@Beazurt "More comments in the engine code. We are recommending this to advanced users. Advanced users want to look at the code to understand what it does. Doesn't need to be perfect or super detailed, but just add some comments to help people navigate the engine."

Beazurt · Answer 4 · Wed Mar 11 2015 05:13:44 GMT+0800 (China Standard Time)

Just made another pass. Most VIs now have their VI documentation updated to reflect the new behavior (no more wrong documentation!). I also added some breadcrumbs to help lead people from the open function to where most of the execution code actually occurs. Still not good enough to close this, but I feel better about it.