search

monicahq / monica

Personal CRM. Remember everything about your friends, family and business relationships.
https://beta.monicahq.com
GNU Affero General Public License v3.0
21.58k stars 2.16k forks source link

Monica’s docs aren’t consistently wrapped, making diffs harder #5657

Open mgrhm opened 2 years ago

mgrhm commented 2 years ago

Monica’s various docs don’t seem to have a consistent line wrap in place. Many – most? – just let lines be as long as they are.

This is poor for diffing them, since you end up with entire paragraphs being shown in the diff rather than the lines actually changed. It’s not just custom that means that under-80 columns is still common in 2021. Markdown is designed to ignore single line-breaks unless they end with two spaces to force a <br> equivalent.

I’d suggest that we pick a consistent, sensible line-wrapping length and then apply it to all of Monica’s documents.

mtlynch commented 2 years ago

Is this a problem that could be solved by a better diff tool? Github and other modern diffing UIs I use show diffs at word-level granularity, so diffing a single long line isn't a problem.

It would be a bit of a pain for documentation authors to manually reflow all lines to 80 columns.