I've been writing programming language documentation for objects. It's surprisingly nuanced!
How do you introduce objects to the reader? What elements should the first example contain? What order do you introduce concepts like methods, inheritance and properties?
miniblog.
Related Posts
I'm exploring how I show lists in my documentation. I like boxes for tidiness, but it's much less space efficient. Which do you prefer?
I should also survey how other sites handle this.
When talking about a match or a switch statement, I've typically seen people talk about individual 'cases' or 'arms'.
TIL Zig uses 'prongs' instead!
I'm trying to decide the best voice for PL documentation.
Passive: "`let` can be used with destructuring."
Reader focused: "You can use `let` with destructuring."
Describing the PL: "FooLang supports destructuring with `let`."
Anyone have opinions or best practices?