| 11 Aug 2023 |
asymmetric | 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 |
Minijackson | In reply to @asymmetric:matrix.dapp.org.uk just to be clear: i'm arguing for soft line breaks (a newline inserted by the editor) at some arbitrary column, say 80 I'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 |
asymmetric | In reply to @Minijackson:matrix.org I'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 do you have an example? or how do they become unreadable? | 07:59:39 |
asymmetric | In reply to @Minijackson:matrix.org I'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 * do you have an example? or could you explain how they become unreadable? | 07:59:52 |
Minijackson | there's some example here: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ | 08:02:46 |
Minijackson | -The beauteous scheme is that now, if you change
-your mind about what a paragraph should look
-like, you can change the formatted output merely
-by changing the definition of ‘‘.PP’’ and
-re-running the formatter.
+The beauty of this scheme is that now, if you
+change your mind about what a paragraph should
+look like, you can change the formatted output
+merely by changing the definition of ‘‘.PP’’
+and re-running the formatter.
| 08:02:58 |
Minijackson | * there's an example here: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ | 08:03:44 |
osslate | 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 |
alejandrosame | 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 |
asymmetric | In reply to @osslate:fsfe.org
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 I’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 |
asymmetric | But the 80 column mark provides an upper bound for sentence length | 09:10:24 |
osslate | In reply to @asymmetric:matrix.dapp.org.uk But the 80 column mark provides an upper bound for sentence length How do you determine the "correct" upper bound for sentence length? | 09:14:20 |
osslate | Documentation isn't poetry 😅 editing is very intuition based (beyond style guides which cover grammar, voice, correct spelling/case for terms) | 09:16:47 |
osslate | 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 |
osslate | 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 |
infinisil | 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 |
infinisil | Or, I've become a big fan of it, makes reviews easier and diffs nicer | 09:52:16 |
infinisil | And hints at sentences that could be broken up | 09:52:41 |
@brian:bmcgee.ie | Have to admit I like semantic line breaks. First time seeing it, but my eyeballs immediately went "yeah, we like that" | 11:31:11 |
@mightyiam:matrix.org | 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 |
Jan Tojnar | zmitchell: did you ever start looking into https://github.com/nix-community/nixdoc/issues/19? | 08:28:57 |
| 13 Aug 2023 |
| @10leej:matrix.org joined the room. | 01:27:06 |
| 14 Aug 2023 |
infinisil | 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 |
asymmetric | 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 |
@mightyiam:matrix.org | Yuki (they/them): help me with sphinx, I'm drowning | 15:18:50 |
@mightyiam:matrix.org | I'm trying to make an extension that replaces the nix-repl language tag with the text language tag. By language tag I mean the first word after the triple backtick in fenced code blocks.
from docutils import nodes
from docutils.parsers.rst import directives
from sphinx.util.docutils import SphinxDirective
class Directive(SphinxDirective):
has_content = True
def run(self):
content = '\n'.join(self.content)
code_block = nodes.literal_block(classes=['nix-repl'], language='text')
code_block.append(nodes.Text(content))
return [code_block]
def setup(app):
app.add_directive('nix-repl', Directive)
| 15:20:59 |
@mightyiam:matrix.org | That stuff doesn't seem to do what I want, though. We still get a warning that there is no such language as nix-repl. | 15:21:42 |
Yuki Langley (they/them) | Why do you want to do this? | 15:23:18 |
Yuki Langley (they/them) | Is the goal to extract all code that has "nix-repl" | 15:23:47 |
Yuki Langley (they/them) | * Is the goal to extract all code that has "nix-repl"? | 15:23:48 |