| Time |
Nick |
Message |
| 02:48 |
|
erlehmann joined #minetest-docs |
| 05:00 |
|
MTDiscord joined #minetest-docs |
| 06:02 |
|
erlehmann joined #minetest-docs |
| 07:56 |
|
appguru joined #minetest-docs |
| 08:16 |
|
appguru joined #minetest-docs |
| 10:44 |
|
appguru joined #minetest-docs |
| 11:04 |
|
appguru joined #minetest-docs |
| 11:26 |
|
appguru joined #minetest-docs |
| 12:14 |
|
appguru joined #minetest-docs |
| 13:05 |
|
appguru joined #minetest-docs |
| 14:55 |
|
appguru joined #minetest-docs |
| 15:29 |
|
appguru joined #minetest-docs |
| 19:37 |
|
Yad joined #minetest-docs |
| 20:06 |
|
appguru joined #minetest-docs |
| 20:06 |
|
erlehmann joined #minetest-docs |
| 21:31 |
MTDiscord |
<Benrob0329> We need to clarify when and how to use each Admonition, I'm seeing a lot of jumps from just TIP to WARNING with no in between |
| 21:36 |
MTDiscord |
<luatic> I usually use "TIP: do the following" and "WARNING: don't do the following" |
| 21:36 |
MTDiscord |
<luatic> often the two are of course related, as in "WARNING: don't do this" and "TIP: use this workaround instead" |
| 21:37 |
MTDiscord |
<Benrob0329> Using two for one statement is bad practice, it's extra visual noise and separates related statements. |
| 21:54 |
MTDiscord |
<josiah_wi> I think CAUTION should typically be used for "don't do the following" and WARNING should be used for "do this and you will regret it" |
| 21:54 |
MTDiscord |
<Benrob0329> To be more specific: asciidoc NOTE: This detail is noteworthy. TIP: This is useful. IMPORTANT: You should _really_ know this. CAUTION: If you're not careful, there may be consequence. WARNING: If you do X, Y will happen. |
| 21:55 |
MTDiscord |
<josiah_wi> If you use WARNING all the time then it will lose its power to communicate something of great importance. |
| 21:55 |
MTDiscord |
<Benrob0329> The difference between CAUTION and WARNING isn't always intuitive, Asciidoctor actually links a whole article on the subject: https://www.differencebetween.com/difference-between-caution-and-vs-warning/ |
| 21:57 |
MTDiscord |
<Benrob0329> Basically, Caution is used when the reader should take care before proceeding, while Warning is used when the reader shouldn't proceed at all. |
| 21:58 |
MTDiscord |
<Benrob0329> WARNING: Don't touch this, you'll die. CAUTION: This knife is very sharp, you could cut yourself if not careful. |
| 22:24 |
MTDiscord |
<Benrob0329> Also, did we all agree that breaking on sentences was our official style? |
| 22:25 |
MTDiscord |
<GreenXenith> What? |
| 22:25 |
MTDiscord |
<GreenXenith> I dont think that was ever discussed |
| 22:25 |
MTDiscord |
<Benrob0329> https://discord.com/channels/369122544273588224/926231483155378176/926938178391265301 |
| 22:26 |
MTDiscord |
<Benrob0329> The short answer is no, it was just noted by Josiah and myself |
| 22:26 |
MTDiscord |
<GreenXenith> Ah, so break internally, which will still show up as normal in render |
| 22:26 |
MTDiscord |
<Benrob0329> yeah |
| 22:26 |
MTDiscord |
<GreenXenith> Im fine with that |
| 22:48 |
MTDiscord |
<Benrob0329> I'd like to add some general format rules to HOWTO, this is what I have so far: asciidoc * Use one sentence per line * Define macros for long URLs, or those used multiple times * Use delimitated example blocks for examples, but not for general function usage |
| 22:50 |
|
Yad_ joined #minetest-docs |
| 22:52 |
MTDiscord |
<Benrob0329> (These are more noteworthy rules than an exhaustive list) |
