From cfafbd243f072f211983d6415032e7a34265354b Mon Sep 17 00:00:00 2001 From: Steve Traugott Date: Tue, 27 Sep 2022 13:17:38 -0700 Subject: [PATCH] add Pl() etc. shortcuts to README --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 76f03cc..6ce6c9d 100644 --- a/README.md +++ b/README.md @@ -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