Paul as this would not be editing existing documents but adding a new one for 
the DataGrid (probably as a single file library with multiple commands etc in 
it) you really wouldn’t need to learn git or use GitHub if you don’t want to. 
Just create the document according to the docs format reference on the guide 
tab of the docs stack and you can pass it around the community for further 
editing if you like then email it to me or (probably better) add it to a bug 
report.

I definitely agree it would be great to have the DataGrid documented in the IDE!

One of the things I’ve done as a side project since starting is start writing 
tests for the documentation. It started with the idea that all examples should 
be tested to see if they compile (there were some great examples of copy paste 
errors in there!) but has been extended to try and validate as much of the 
document as possible against the format specification. It’s looking for things 
like undocumented parameters or extra parameters that aren’t in the syntax 
statements, broken syntax statements and whether API docs have summaries. 
Needless to say there’s a big long list of things to fix (493 to be exact!) and 
the tests don’t cover everything yet! I may need to call on the community to 
give me a hand so we can get these things fixed, get the test into the the repo 
and have them run for every change to the docs.

Cheers

Monte



_______________________________________________
use-livecode mailing list
use-livecode@lists.runrev.com
Please visit this url to subscribe, unsubscribe and manage your subscription 
preferences:
http://lists.runrev.com/mailman/listinfo/use-livecode

Reply via email to