Nix Documentation | 438 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 92 Servers |
| Sender | Message | Time |
|---|---|---|
| 11 Aug 2023 | ||
| I know Valentin is a fan | 07:47:33 | |
| There's some reasoning explained here: https://sembr.org/, although sembr advocates for more line breaks than one per sentence | 07:48:57 | |
| As a technical writer, I mostly like line breaks because it's a useful visual indicator of "this sentence is too long and hard to follow and should be split up" | 07:54:59 | |
| * As a technical writer, I mostly like line breaks because it's a useful visual indicator of "this sentence is too long and hard to follow and should be split up or rephrased" | 07:55:11 | |
| just to be clear: i'm arguing for soft line breaks (a newline inserted by the editor) at some arbitrary column, say 80 | 07:55:49 | |
In reply to @asymmetric:matrix.dapp.org.ukI've done that for quite some time, but I found that diffs becomes unreadable, which is an issue for PRs that needs to be reviewed | 07:58:38 | |
In reply to @Minijackson:matrix.orgdo you have an example? or how do they become unreadable? | 07:59:39 | |
In reply to @Minijackson:matrix.org* do you have an example? or could you explain how they become unreadable? | 07:59:52 | |
| there's some example here: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ | 08:02:46 | |
| 08:02:58 | |
| * there's an example here: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ | 08:03:44 | |
| I liken it to: imagine a program written in something like Nix or C. Now, imagine instead of one statement per line, the entire program was smushed together, with newlines only occurring at the 80 col mark. ...now, imagine receiving a substantial PR to change something in that spaghetti :D | 08:04:37 | |
infinisil: I'm already part of NixOS/nixpkgs-maintainers -> https://discourse.nixos.org/t/join-the-package-maintainer-team/3751/68?u=alejandrosame | 08:38:03 | |
In reply to @osslate:fsfe.orgI’m not saying new lines should only be at the 80 column mark, people are free to break after each sentence according to semantics, presentation, etc | 09:09:56 | |
| But the 80 column mark provides an upper bound for sentence length | 09:10:24 | |
In reply to @asymmetric:matrix.dapp.org.ukHow do you determine the "correct" upper bound for sentence length? | 09:14:20 | |
| Documentation isn't poetry 😅 editing is very intuition based (beyond style guides which cover grammar, voice, correct spelling/case for terms) | 09:16:47 | |
| Also considering that a defined column length will be inclusive of markup (code segments, bold, italic, etc.) which isn't ideal either | 09:19:15 | |
| Contradicting myself here after saying "documentation isn't poetry", but a real metric that can be used is word count in an individual sentence. Column wrapping isn't useful to get that metric, though | 09:24:31 | |
| I've been using the one-sentence-per-line convention for some time now, and I'm a big fan of it. | 09:48:37 | |
| Or, I've become a big fan of it, makes reviews easier and diffs nicer | 09:52:16 | |
| And hints at sentences that could be broken up | 09:52:41 | |
| Have to admit I like semantic line breaks. First time seeing it, but my eyeballs immediately went "yeah, we like that" | 11:31:11 | |
| I can use some help with this pty-in-build-phase problem: https://github.com/NixOS/nix.dev/pull/672#issuecomment-1674627870 | 12:08:53 | |
| 12 Aug 2023 | ||
| zmitchell: did you ever start looking into https://github.com/nix-community/nixdoc/issues/19? | 08:28:57 | |
| 13 Aug 2023 | ||
| 01:27:06 | ||
| 14 Aug 2023 | ||
| I spent a lot of time on https://github.com/NixOS/nixpkgs/pull/245243, it's a beast, but it would be great to get some rough review on it and then merge it. It's not perfect, but it makes a lot of improvements. | 03:18:56 | |
| Just found out about outreachy: https://www.outreachy.org/ Guix has been one of the projects interns could work on: https://www.outreachy.org/communities/cfp/gnu-guix/ Maybe we could look into this? | 08:06:53 | |
| Yuki (they/them): help me with sphinx, I'm drowning | 15:18:50 | |
| I'm trying to make an extension that replaces the
| 15:20:59 | |