Zjpm: formatting: too high column widths per line

riscv / riscv-j-extension

Working Draft of the RISC-V J Extension Specification

https://jira.riscv.org/browse/RVG-128

Creative Commons Attribution 4.0 International

162 stars 17 forks source link

Zjpm: formatting: too high column widths per line #31

Closed deepak0414 closed 6 months ago

deepak0414 commented 1 year ago

Column widths are way too high for each line. github is probably wrapping them around certain column width but new lines are coming at high column numbers.

It's difficult to create PRs with such high column width. It'll nice to have column width for each line to be max at 100.

 debug@debug$ awk 'length>max{max=length}END{print max}' zjpm/introduction.adoc 
486

martinmaas commented 1 year ago

I think this is, to a certain extent, a matter of preference and I have found the opposite to be the case (my editor wraps paragraphs and when making changes to a paragraph that is split into multiple lines, it makes the diff very difficult to read when a small change causes the line breaks to end up in different places.

This may be a good topic for RVI to standardize at some point, but for now, I would personally prefer to leave it as is. I will leave this issue open for now, in case there is a lot of demand for making this change from the group.