!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

436 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
10 Nov 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Style question: do we capitalize every (important) word in titles, or just the first?
Statistically speaking only the first. The reason is because I find that saner than learning rules that donโ€™t apply for any other parts of the text, and I merged a lot of stuff. Would help to add that to the style guide.
12:49:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Style question: do we capitalize every (important) word in titles, or just the first?
* Statistically speaking only the first. The reason is because I find that saner than learning rules that donโ€™t apply for any other parts of the text, and I merged a lot of stuff. Would help to add that to the style guide if we agree on it.
12:50:29
@asymmetric:matrix.dapp.org.ukasymmetricwdym statistically?12:51:09
@asymmetric:matrix.dapp.org.ukasymmetricfwiw i think capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web12:51:38
@asymmetric:matrix.dapp.org.ukasymmetric * fwiw capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web12:51:44
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
wdym statistically?
A large part is like that
12:57:04
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
wdym statistically?
* A large fraction of headings is like that
12:57:14
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
fwiw capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web
It is and I find it stupid but I may be wrong.
12:57:39
@asymmetric:matrix.dapp.org.ukasymmetricthe point of standards is not necessarily that they're the most intelligent solution out there. but point taken ๐Ÿ˜‰ personally, i'm fine with going for sentence-capitalization. i'll open a pr to discuss further12:59:58
@toonn:matrix.orgtoonn It's mostly a US - Europe divide AFAIK. 13:16:32
@Minijackson:matrix.orgMinijacksonthe Microsoft Style Guide recommends sentence-style capitalization: https://learn.microsoft.com/en-us/style-guide/capitalization14:14:02
@Minijackson:matrix.orgMinijacksonwasn't there some efforts recently for adding vale to nix.dev? There's a lint for that14:14:52
@asymmetric:matrix.dapp.org.ukasymmetricmicrosoft.png
Download microsoft.png
14:52:56
@asymmetric:matrix.dapp.org.ukasymmetricseems like they're breaking their own style guide here?14:53:49
@Minijackson:matrix.orgMinijacksonoh you mean "Microsoft Style Guide" ?14:54:22
@Minijackson:matrix.orgMinijacksonI guess so ๐Ÿ˜†14:54:41
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
seems like they're breaking their own style guide here?
We should open a PR. (not really)
14:57:02
@asymmetric:matrix.dapp.org.ukasymmetrici know people at microsoft, i'll call them immediately14:57:19
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @toonn:matrix.org
It's mostly a US - Europe divide AFAIK.
In that case it's settled, because we already have many eurocentric conventions and I'd like to keep it consistent.
14:58:05
@asymmetric:matrix.dapp.org.ukasymmetricsettled in which direction?14:58:39
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
settled in which direction?
Sentence-style capitalisation
14:58:48
@asymmetric:matrix.dapp.org.ukasymmetriclol @ capitaliSation though14:58:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
lol @ capitaliSation though
British English: https://en.wiktionary.org/wiki/capitalisation
14:59:46
@asymmetric:matrix.dapp.org.ukasymmetricOxford British would like to have a word with you though15:00:11
@asymmetric:matrix.dapp.org.ukasymmetricanyway, that's a separate rabbit hole, i'm out ๐Ÿ˜‰15:00:34
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @Minijackson:matrix.org
wasn't there some efforts recently for adding vale to nix.dev? There's a lint for that
indeed there is https://vale.sh/docs/topics/styles/#capitalization. we should add vale
15:12:51
@proofconstruction:matrix.orgproofconstruction it would be great to be able to declare the style guide, and have that automatically checked (and ideally auto-corrected) everywhere 15:38:37
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @proofconstruction:matrix.org
it would be great to be able to declare the style guide, and have that automatically checked (and ideally auto-corrected) everywhere
wdym? isn't a vale config file a declaration of (parts of) the style guide?
16:03:22
@proofconstruction:matrix.orgproofconstructionyes, I'm saying I support adding it16:04:04
@proofconstruction:matrix.orgproofconstructionrereading my previous message I can see that isn't at all clear. oops16:04:45

Show newer messages


Back to Room ListRoom Version: 6