!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

430 Members
Discussion about documentation improvements around the Nix ecosystem89 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
7 Nov 2023
@infinisil:matrix.orginfinisil
In reply to @asymmetric:matrix.dapp.org.uk
as future work or as out of scope?
I don't think there's an out of scope section. Future work sounds good
10:56:06
8 Nov 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk

https://discourse.nixos.org/t/a-portable-nix-shell-shebang/35148/2

What do you think? If we want this, anyone interested in seeing it through?

00:26:48
@fricklerhandwerk:matrix.orgfricklerhandwerk * https://discourse.nixos.org/t/a-portable-nix-shell-shebang/35148/2
What do you think? 👍👎? If we want this, anyone interested in seeing it through?
00:27:31
@infinisil:matrix.orginfinisilIt's a bit non-standard, but it seems fine02:27:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @infinisil:matrix.org
It's a bit non-standard, but it seems fine
We could iterate on it
07:38:23
9 Nov 2023
@raboof:matrix.orgraboofdo we have any doc writing guidelines such as "try to avoid words like 'simply'"?09:10:41
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @raboof:matrix.org
do we have any doc writing guidelines such as "try to avoid words like 'simply'"?

Whe have a style guide for nix.dev https://nix.dev/contributing/documentation/style-guide

but no specific note on “simply”.

09:33:34
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @raboof:matrix.org
do we have any doc writing guidelines such as "try to avoid words like 'simply'"?
what's your beef with "simply"? 😃
09:50:15
@raboof:matrix.orgraboofin short, documentation is almost always better without it: it is typically added to encourage the reader, but often has the opposite effect and may even appear condescending, especially when the reader runs into trouble trying to apply the suggestions from the documentation. Best-case it's mostly just noise. I'm sure others have motivated this better than I can in a few sentences though, I can see if I can dig up any good references later - first wanted to see if we had any already.09:55:08
@fricklerhandwerk:matrix.orgfricklerhandwerkIn short: what’s simple for you may be impossible for others. Avoiding that is in line with our stance not to assume things about the reader10:03:08
@fricklerhandwerk:matrix.orgfricklerhandwerk* In short: what’s simple for you may be impossible for others. Avoiding that is in line with our stance not to assume things about the reader and not making value judgements10:03:38
@fricklerhandwerk:matrix.orgfricklerhandwerkThat’s why for instance in reviews I always suggest alternatives to “as you can see…” or “you will see an output…” – no, not everyone can see.10:05:55
@fricklerhandwerk:matrix.orgfricklerhandwerkThere are entire software companies full of people who can’t see.10:07:28
@asymmetric:matrix.dapp.org.ukasymmetricMy pet peeve is "trivial" 😂10:45:38
@fricklerhandwerk:matrix.orgfricklerhandwerk“Left as an exercise for the reader”11:20:52

Show newer messages


Back to Room ListRoom Version: 6