Luanti logo

IRC log for #luanti-docs, 2025-02-23

| Channels | #luanti-docs index | Today | | Google Search | Plaintext

All times shown according to UTC.

Time Nick Message
03:45 MTDiscord <wsor4035> was going to write a doc tonight, but probably shouldnt till marks pr is merged
04:20 MTDiscord <mark.wiemer> @wsor "changing lists from * to - seems sub optimal" I went with Prettier defaults to simplify things. Do you see a strong reason we should go against defaults? What is sub optimal about the change?
04:23 MTDiscord <wsor4035> in my opinion, also seen * used for lists in markdown, could just be a me thing
04:24 MTDiscord <mark.wiemer> Yeah both work. It sounds like this isn't a blocker? We can always change back later if we see issues
04:24 MTDiscord <wsor4035> which also most of your conversion is things that are already using * 🙃
04:25 MTDiscord <mark.wiemer> Yeah, but it's a one-time change, I don't see it as too big a deal
04:25 MTDiscord <wsor4035> kinda stupid in my opinion to change them all just to change it back
04:26 MTDiscord <wsor4035> not to mention adding two net pointless commits
04:26 MTDiscord <wsor4035> (if that is what was to happen)
04:31 MTDiscord <wsor4035> it is possible that im just the odd one out, and that others prefer - 🤷
04:34 MTDiscord <wsor4035> looks like it used to be * but was then changed in 2018 https://github.com/prettier/prettier/issues/4251
04:34 MTDiscord <wsor4035> though depending on what numbers you look at, the stats are 60/40 favoring one or the other 😐
04:38 MTDiscord <wsor4035> so in the content directory currently grep -r "^* " | wc -l 4454 grep -r "^- " | wc -l 597
04:39 MTDiscord <wsor4035> so the code base by far currently prefers *
04:39 MTDiscord <wsor4035> also would reduce your pr by ~1/3 its current size
04:40 MTDiscord <wsor4035> assuming i didnt fuck up the grep pattern, which is totally possible
04:40 MTDiscord <wsor4035> actually lol, the -  results are probably mostly from yaml lists for aliases
04:41 MTDiscord <wsor4035> grep -r "^- /" | wc -l 305
04:42 MTDiscord <wsor4035> so the true number of actual markdown lists using - is 292
04:54 MTDiscord <wsor4035> if i understand this correctly, markdownlint which is popular for formatting markdown seems to use * interestingly https://github.com/DavidAnson/markdownlint/blob/main/doc/md004.md
05:00 MTDiscord joined #luanti-docs
05:02 MTDiscord <wsor4035> the whole above is pointless, since prettier doesnt allow you to configure it 🙄
05:02 MTDiscord <wsor4035> markdownlint does interestingly enough
05:43 MTDiscord <mark.wiemer> The reason our lists use stars is because the converter we used uses stars. Ultimately, what does this impact? Why not just use dashes and move on?
05:43 MTDiscord <mark.wiemer> Reducing the size of this single PR won't matter in the long term
06:07 MTDiscord <wsor4035> Still think * is better, but it doesn't really matter since there isn't anything one can do about it
06:08 MTDiscord <greenxenith> I personally use * because it looks closer to a bullet point but I really dont care since I can type * and the formatter will change it
06:09 MTDiscord <greenxenith> In the end it will be rendered the same anyway
09:22 Warr1024 joined #luanti-docs
09:46 Warr1024 joined #luanti-docs
13:02 MTDiscord <warr1024> I stick with -, because (1) it always looks like a bullet point in any font (different fonts don't try to make it look different amounts of "superscripty") and (2) it's easier to type, being a single keystroke, and doesn't require the cognitive overhead of coordinating multiple hand shift usage.
14:57 Desour joined #luanti-docs
15:12 MTDiscord <mark.wiemer> I think this is what matters. Type what you want, star or dash. The formatter will make it a dash for consistency. Ultimately the UX is the same, the DX is basically the same, the only change is a character in the source. Does anyone feel this is a blocker?  If it's not a blocker, I'd appreciate a review on the rest of the changes 🙂
19:44 MTDiscord <mark.wiemer> I plan to merge my changes in 36 hours unless I hear an objection, if that's OK
19:45 MTDiscord <mark.wiemer> Link is https://github.com/luanti-org/docs.luanti.org/pull/201 for reference
20:15 pattmax joined #luanti-docs
21:04 mark-wiemer joined #luanti-docs

| Channels | #luanti-docs index | Today | | Google Search | Plaintext