Author Archives: Richard Hainsworth

Day 22 – Wrapping a Christmas Present

A few months back In the smoke-filled (virtual) room of the council of the high (from the smoke) elves, the wizened textualist Geoff, said “All of my stuff is in boxes and containers.” Empty shelves behind him indicated he was moving house. “When you have a complex module,” Geoff continued, “and its difficult to describeContinue reading “Day 22 – Wrapping a Christmas Present”

Day 14 – Playing around with the new documentation components

After living with RakuDoc v2 for over a year, some things become normal that surprise others when I explain them. Here are a few things I do when documenting my software. 1. Shoving stuff down the file There are a couple of items needed in a changing document that should be easily managed, probably atContinue reading “Day 14 – Playing around with the new documentation components”

Day 1 – Rendering down for Christmas

Last Christmas we got a new specification for RakuDoc, and this Christmas we have a generic rendering engine for RakuDoc V2. “So what?” some may say. “So WHAT !! ?? !!” shouts an inner demon of mine, having struggled for a year to get all the new stuff working, and wasting weeks on getting escapingContinue reading “Day 1 – Rendering down for Christmas”

Day 12 – Perspectives on RakuDoc Version 2

Just in time for Christmas This project started with the modest aim of documenting parts of Rakudoc V1 (what used to be called POD6 that had been specified, but not included in the original documentation. Except … some parts of the specification had not been implemented in the Pod::To::HTML renderer. And some parts were outdated. So aContinue reading “Day 12 – Perspectives on RakuDoc Version 2”

Day 17: How to clarify which parts of the documentation change

Using Pod::To::HTML2 a new custom FormatCode, D<> (D for deprecation), can be made to help with the Raku Documentation process. The new FormatCode should show a span of documentation that is deprecated in some way. This happens a lot when Rakudo is being upgraded. However, people using older versions of Rakudo need to understand whatContinue reading “Day 17: How to clarify which parts of the documentation change”