Adorkable/swift-log-format-and-pipe

Include log examples in BasicFormatter docs?

ktoso opened this issue · 4 comments

ktoso commented

From skimming documentation it is hard to decide which formatter to choose;

Could docs of .adorkable https://adorkable.github.io/swift-log-format-and-pipe/Structs/BasicFormatter.html#/s:20LoggingFormatAndPipe14BasicFormatterV9adorkableACvpZ

in addition to:

Adorkable’s go-to log format 😘

also include a small sample?

(same about the .apple one?)

yoiang commented

Hey @ktoso , great call!

That and the README should include examples of all the components in the BasicFormatter vs sorting through the API docs.

  • 👍1
yoiang commented

@ktoso let me know if #5 is what you were thinking!

yoiang commented

Closing for now

ktoso commented

Thanks a lot for the follow up!
Submitted a post-merge review, hope this helps 👍

#5 (review)