Logging for fun and profit

Just cross-linking to may post here about demo docs offered for general use noting their version at submission. I’ve got docs going back to v2.3.4 and the app’s changed a lot.

So, might I suggest add function to ‘log’ (add) a root note indicating current version of the doc as at saving. This can aid a later user figure if a seeming error is due to their re-use or to interim changes in Tinderbox features. Should the author update their doc, they’d then replace cor annotate//update this colophon note.

Now we have both action code functions and the notion of transferrable (code) library notes, annotation such as above might prove useful. Another useful library feature might stamp code to add to library note text a function shell with boilerplate comments indicating where to annotate input argument and return type/purpose, etc.

1 Like