Sunday, May 25, 2025

WhioDoc Updates - Version 1.1 just released

I've just released a minor update to WhioDoc to add some clarity + tweaks around the formatting of range-specifiers, and guidance on how "complex type specifiers" should be documented (i.e. "there is no established standard here yet, as you're probably doing something wrong if you need it")

 

Links to WhioDoc Repo:

* The Repo:  https://github.com/Aligorith/whiodoc

* Today's Updates:   

    https://github.com/Aligorith/whiodoc/commit/66aba8762073eabd948872e149323f17584a2b87

 

Key Points:

* Changed the delimiter for "type vs range" parts of the range-specifiers to use "::" instead of "-" 

   This has been changed after I realised on my current project that the "-" is really not too visible in my text editor (where I usually have "show all whitespace" enabled now - long story for another day), and a more heavy-weight symbol was needed.

  i.e. The recommended format is now something like:

         (Num :: 0.1 <= v < 0.9)

 

In other news:

The lack of news / updates here recently is because I'm currently hard at work on a bunch of projects, with a view towards getting some of them in a shippable state. And with that, I need to get back to actually building stuff, and less time talking about building it!  Over and out!