Sunday, March 2, 2025

Introducing... "WhioDoc" (formerly "Quack!" / "QuackDoc")

I guess this weekend can be considered somewhat successful on the projects front (even though I only really got around to 1 of the 3 projects I'd wanted to work on, though it *was* the most important one I wanted to knock off too)

Following a few sessions of toil, I have successfully put up an initial attempt at formalising all the conventions I've been using for writing inline code docs for all my projects over the years!

While there are still a few small loose ends to tack on, at least I can finally point to this thing and say: Here's the spec!

(And eventually: "Here's all the docs-compiler tools + editor plugins everyone asks for these days")

 


https://github.com/Aligorith/quackdoc

https://github.com/Aligorith/whiodoc

 

 

The name needs work though...

I had to quickly think of something to name the repo so I could create + upload it, and ended up pulling a blank, and thought... "Duck Typing" hmm... let's call it "Quack!".

(Note: I did alternatively consider calling it "CDIO" instead, which seemed blegh too... but in retrospect, that may seem a bit more respectable than calling it something quirky but pronounceable1)

Naming stuff is hard 😅

 

EDIT: Following a suggestion from "@Daveosaurus@mastodon.nz", I've renamed it to "WhioDoc" (after NZ's endemic "Blue Duck") - The more I thought about it, the more this made sense + was quite fitting, so "WhioDoc" it is!

A few other interesting alternatives that came up while fact-checking that name and/or reading other news around this time:

* "Whiro" (i.e. from adding an extra "r" after making a misremembered typo) apparently refers to "the lord of darkness and embodiment of all evil in Māori mythology" 

* "Kumi" (i.e. from the following sad news that a member of the critically endangered Kakapo species had recently died, leaving just 243 adult kakapo in the world!) - Apparently the name comes from a Maori translation that means "a huge, fabulous monster"

 ... am I somehow sub-conciously trying to get at something here?  Or was that universe-mail calling again?   😜

No comments:

Post a Comment