haskell-terminal
haskell-terminal copied to clipboard
(minor) documentation fixes
some suggestions:
- link to the examples under
app(and imo, rename the directory toexamples). - inline some examples (or sections thereof) into the README. for example, mention which lines are internal to the project, and which are external (in particular,
prettyprinterfunctions). - add
PackageImportsto example files, for clarity. - add qualified imports to example files, for clarity (in particular,
PPor something forprettyprinter) - show escaping behavior in an example (unless I'm misunderstanding one of the comments I read, only escape sequences for newlines and tabs are preserved; the rest, like the escape character
\ESC, must be done in other ways, like withannotate).
i can do these (or whichever subset you want), if you're interested.
Feel free to add PRs. I broke most examples in master right now. Might be a bit too early for fine-tuning right now, though.
will do (and thanks for the prompt replies!)