Python is the only language I've seen where the stdlib docs contain smilies: https://docs.python.org/3.6/library/heapq.html#theory
It makes the docs more approachable, but also shows the diversity of writing styles used!
Related Posts
I've been writing docs for different programming language operators (+, *, == and so on). Each one gets a separate web page.
I've suddenly realised that / is much harder! docs/+ and docs/== is fine, but docs// just doesn't work as a URL in a static site.
Any ideas?
There are docs resources like https://diataxis.fr/ that categorise documents based on format and intended audience.
They don't say where you should start, or what order you should write docs.
I'm currently thinking README > reference > tutorial > how-tos. Agree/disagree?
I'm playing with Zeal/Dash so I can view stdlib docs offline.
(I've been coding on public transport recently, without a reliable data connection.)
Anyone have tips for making the most of this setup? AFAICT docsets are basically HTML underneath.