Better documentation of generated functions - Githubissues

tschrijv / AutBound

Code voor Abstract Syntax Tree Code Generator for Haskell-based Com- and Transpilers

1 stars 0 forks source link

Better documentation of generated functions #3

Closed VonTum closed 4 years ago

VonTum commented 4 years ago

inline in the generated code

xySubstitute ambiguity: termTermSubstitute :: Term -> Variable -> Term -> Term which term is substituted in which?

Useful for IDEs, so the user can see documentation on hover

in the readme

What causes the tool to generate certain functions?
such as xyzmap, xyzabcSubstitute, freeVariablesXYZ?
What do these functions do?