summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorJeff Carr <[email protected]>2023-12-30 20:48:24 -0600
committerJeff Carr <[email protected]>2023-12-30 20:48:24 -0600
commitd7d3fbc3a31dbba4de1737244f39945608e5a0ac (patch)
tree6e37fcd9ffaec23dbc81fe2d0fb57e3813bed540 /doc.go
parent424a1b42e294e89a6f893196ebf23ba3d20572db (diff)
more or less functional draft
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..902ca38
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,32 @@
+package log
+//
+// version v1.5
+//
+// I like things to be easy.
+//
+// this means all the log settings are in one place. it should allow
+// things to be over-ridden externally to the library
+// but still allow command line --args to pass debugging settings
+//
+// I also have a generic sleep() and exit() in here because it's simple
+//
+// Usage:
+//
+// log.Info("something", foo, bar)
+// log.Bool(DEBUG, "something else", someOtherVariable) # if DEBUG == false, return doing nothing
+//
+
+/*
+ I've spent, am spending, too much time thinking about 'logging'. 'log', 'logrus', 'zap', whatever.
+ I'm not twitter. i don't give a fuck about how many nanoseconds it takes to log. Anyway, this
+ implementation is probably faster than all of those because you just set one bool to FALSE
+ and it all stops.
+ Sometimes I need to capture to stdout, sometimes stdout can't
+ work because it doesn't exist for the user. This whole thing is a PITA. Then it's spread
+ over 8 million references in every .go file. I'm tapping out and putting
+ it in one place. here it is. Also, this makes having debug levels really fucking easy.
+ You can define whatever level of logging you want from anywhere (command line) etc.
+
+ log() # doesn't do anything
+ log(stuff) # sends it to whatever log you define in a single place. here is the place
+*/