Skip to content

Commit

Permalink
add Pl() etc. shortcuts to README
Browse files Browse the repository at this point in the history
  • Loading branch information
stevegt committed Sep 27, 2022
1 parent b09b85c commit cfafbd2
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Expand Up @@ -15,12 +15,22 @@ Inspired in part by Dave Cheney's
Lainio's [https://github.com/lainio/err2](https://github.com/lainio/err2).

This package includes several other possibly-useful functions,
including Assert(), Debug(), and Pprint(). Docs are admittedly still
thin -- see ./examples here and [elsewhere on
github](https://github.com/search?q=github.com%2Fstevegt%2Fgoadapt+extension%3A.go&type=Code&ref=advsearch&l=&l=) for now.
including Assert(), Debug(), and Pprint(), as well as a few shortcut
vars for common `fmt` functions:

```
Pl = fmt.Println
Pf = fmt.Printf
Spf = fmt.Sprintf
Fpf = fmt.Fprintf
```

Docs are admittedly still thin -- see ./examples here and
[elsewhere on github](https://github.com/search?q=github.com%2Fstevegt%2Fgoadapt+extension%3A.go&type=Code&ref=advsearch&l=&l=)
for now.

## TODO

- add more doc comments
- add more examples
- integrate examples into test cases
- add more examples for full coverage

0 comments on commit cfafbd2

Please sign in to comment.