Skip to content

(minor) documentation fixes #9

@sboosali

Description

@sboosali

some suggestions:

  • link to the examples under app (and imo, rename the directory to examples).
  • 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, prettyprinter functions).
  • add PackageImports to example files, for clarity.
  • add qualified imports to example files, for clarity (in particular, PP or something for prettyprinter)
  • 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 with annotate).

i can do these (or whichever subset you want), if you're interested.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions