sbddesign / bolt12.org

BOLT12.org Website
https://bolt12.org
7 stars 4 forks source link

Debate proper spacing #57

Open sbddesign opened 4 months ago

sbddesign commented 4 months ago

Is it "BOLT 12" or "BOLT12"?

sbddesign commented 4 months ago

There's a space between BOLT and the number, according to protocol docs;

Screenshot 2024-06-11 at 2 06 32 PM Screenshot 2024-06-11 at 2 07 25 PM
moneyball commented 4 months ago

Interestingly Optech doesn't use a space. https://bitcoinops.org/en/topics/offers/

But doesn't reference "BOLT" in the style guide. https://github.com/bitcoinops/bitcoinops.github.io/blob/master/STYLE.md

harding commented 4 months ago

Like @moneyball says, Optech doesn't use extra spaces or dashes or zeroes for BIPs or BOLTs, e.g. BIP123 and BOLT12. My reasoning is

  1. It's clear either way, but when clarity and correctness is achieved, shorter is almost always preferable as it allows more text to appear on a page and makes that text look less intimidating
  2. When a space is used, you have to worry about annoying line breaks, e.g. BOLT
    12.
  3. It's easier to search without a space (e.g. you can type BOLT12 into a search engine by itself but you'd have to type "BOLT 12" when the space is used).

That said, I don't think with-or-without-spaces is too important, but I would more strongly discourage using the hash symbol (e.g. BOLT #12) because it has all the downsides of having a space, is even longer, doesn't match how we say things aloud (e.g. we say "bolt twelve" not "bolt number 12") and because GitHub, Twitter, and other platforms are always trying to turn hash-prefixed things into random links, e.g. BOLT #12