docs(code-style-guide): Add comment rules

[Techassi]

This adds a bunch of rules regarding Rust comments.

Direct link

[netlify]

✅ Deploy Preview for stackable-docs ready!

Name	Link
🔨 Latest commit	6fb30e2
🔍 Latest deploy log	https://app.netlify.com/sites/stackable-docs/deploys/66f543204132680008499950
😎 Deploy Preview	https://deploy-preview-668--stackable-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sbernauer]

Works for me. Do we need a decision for this? (e.g. I personally prefer 120 chars, but could live with 100)

[Techassi]

Works for me. Do we need a decision for this? (e.g. I personally prefer 120 chars, but could live with 100)

We can open a decision for this, but tbh, I wouldn't push beyond 100 characters. Rust's std and core library for example also use line-widths between 80 and 100.

Beyond that point, it gets hard to read. It is well known at this point, that you should avoid using long lines of continuous text to easy the process of reading it.

[sbernauer]

Works for me. I think we should put it on the decision board, just so that people could veto - but I don't expect any veto

[Techassi]

Moving this into voting. Options are:

• 👍 Accept as is
• 👎 Don't accept, post desired changes in comments

[stefanigel]

"line-widths between 80 and 100" - I was not aware that Rust is so close to FORTRAN :-)

[Techassi]

"line-widths between 80 and 100" - I was not aware that Rust is so close to FORTRAN :-)

I should clarify: Just for the comments, code is usually formatted at 100 and above. But yes, developers like their narrow comments :)

[NickLarsenNZ]

I just like narrow for reviewing side by side. Otherwise I like 100.

No action needed, just sharing.

[razvan]

Does the max line length apply to code too?

[Techassi]

Does the max line length apply to code too?

No, we are only talking about comments. Rust code is formatted by rustfmt anyway and it will format with a width of ~100 and above.

[Techassi]

There seems to be no further activity. I will mark this decision as accepted tomorrow and move it to "Done" afterwards.

[Techassi]

Marking as accepted.