miniblog.

← Back to all posts
Aug 15, 2022 at 02:34
Do you think language/API docs websites should support comments? Pros: Adds context, familiar format, engages community Cons: Can disincentivise contributions, comments might promote bad practices I've only seen PHP and clojuredocs offer this.

Related Posts

Mar 28, 2025 at 03:21
47
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?
Feb 10, 2024 at 20:15
The Ruby on Rails guides use "please" when suggesting other resource to read or best practices to follow. For example: https://guides.rubyonrails.org/autoloading_and_reloading_constants.html I've not seen this docs convention before. I certainly see the appeal for describing best practices: "your collaborators will appreciate it!"
Autoloading and Reloading Constants — Ruby on Rails Guides
Autoloading and Reloading Constants — Ruby on Rails Guides
This guide documents how autoloading and reloading works in zeitwerk mode.After reading this guide, you will know: Related Rails configuration Project structure Autoloading, reloading, and eager loading Single Table Inheritance And more
Feb 7, 2023 at 01:37
Which programming languages are the closest to 'finished'? In other words, which are unlikely to expand core features or syntax such that best practices change. C and Scheme seem to fit this, are there other languages?