> I think the use of templates like this for function documentation > encourages the creation of tautological documentation. > [...] > I favour forsaking the template altogether and writing a brief > description of the function, with a note describing anything unusual.
I fully agree. This is something I've often struggled with - a good function signature usually makes parameter documentation redundant - and I think your conclusion is very reasonable. (FWIW, I think that the reference to autoSaveChanges is actually important in this example.) So we should now be able to Just Do It. Perhaps I'll look into extending the parser with basic support for internal links, as that might be handy (e.g. in the case of saveTiddler referencing autoSaveChanges). -- F. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/TiddlyWikiDev?hl=en -~----------~----~----~----~------~----~------~--~---
