Sunday, March 2, 2025

Introducing... "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

 

 

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 😅

No comments:

Post a Comment