23
Do you have a favourite way of highlighting text in a CLI error message? Currently I'm using backticks, but I'm wondering what's the most readable.
miniblog.
Related Posts
2
What's the best string representation of a function? Comparing with other PLs:
Python: <function __main__.add_one()>
JS: [Function: addOne]
Clojure: #function[user/add-one]
Scheme: #<procedure add-one (x)>
I'm currently thinking about <fun add_one() foo.gdn:123>
12
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 still trying to find a sweet spot between 'show the general syntax' and 'show a concrete example' in the CLI docs for difftastic.
https://difftastic.wilfred.me.uk/usage.html
I'm currently showing the syntax, immediately followed by an example. What do you think?
