Docs: reflow some markdown text files #13778

pull jsarenik wants to merge 1 commits into bitcoin:master from jsarenik:jasan/experiment changing 7 files +402 −312

jsarenik commented at 8:23 AM on July 27, 2018: none
Though the plain text was pretty good (mostly 80-char lines), this makes it even more readable for terminal monks. The fancy HTML5 markdown output on GitHub is the same (checked with rendering original and changed file with commonmarker and normalizing both with HTML tidy, the only change being the simplified in-tree doc path for Translation Process).

One more little change is that http://chris.beams.io was changed to https as suggested by @fanquake.
```
commonmarker CONTRIBUTING.md | tidy > /tmp/aoeui.html
git checkout master
commonmarker CONTRIBUTING.md | tidy | diff -u - /tmp/aoeui.html
```
- INSTALL.md: Add monospace markup to file name
- CONTRIBUTING.md - reflow the text - no change in wording
- contrib/qos/README.md - fmt (reflow and wrap long lines)
- reflow release-notes.md
- README.md reflow
- depends/packages.md - reflow
Ref: https://github.com/ElementsProject/lightning/pull/1137

This is yet another take on before-unmerged https://github.com/bitcoin/bitcoin/pull/11759

Docs: reflow some markdown text files

Though the plain text was pretty good (mostly 80-char lines),
this makes it even more readable for terminal monks. The fancy
HTML5 markdown output on GitHub is the same (checked with rendering
original and changed file with `commonmarker` and normalizing both
with HTML `tidy`, the only change being the simplified in-tree doc
path for Translation Process).

One more little change is that http://chris.beams.io was changed
to https as suggested by @fanquake.

    commonmarker CONTRIBUTING.md | tidy > /tmp/aoeui.html
    git checkout master
    commonmarker CONTRIBUTING.md | tidy | diff -u - /tmp/aoeui.html

 - INSTALL.md: Add monospace markup to file name
 - CONTRIBUTING.md - reflow the text - no change in wording
 - contrib/qos/README.md - fmt (reflow and wrap long lines)
 - reflow release-notes.md
 - README.md reflow
 - depends/packages.md - reflow

Ref: https://github.com/ElementsProject/lightning/pull/1137

773c94ebfb

fanquake added the label Docs on Jul 28, 2018
laanwj commented at 11:52 AM on July 30, 2018: member

I think this is quite pointless, sorry. Collides with all other changes to these files, and for what reason, just to shuffle some words around.

It also has the potential for generating infinite future PRs (that reflow again and again). So have to tend towards NACK.
jsarenik commented at 5:27 AM on July 31, 2018: none

Hi Vladimir!

It's totally fine. I just wanted to publish this patch that I kept rebasing locally. Forget about it and close this PR please. I can not close it myself at the moment (email only).

On the other hand your comment about infinite future PRs made me wonder :-)

When I was younger I used to guess worthiness of some software project just by reading its textual plaintext documentation in terminal with standard width (80 characters). Some pass this test until now. For example see https://rawgit.com/torvalds/linux/master/Documentation/process/coding-style.rst

It's a matter of culture so take it easy. I appreciate a lot what is happening in bitcoin/bitcoin and wishing you all the best success!

https://www.jasan.tk
promag commented at 1:44 PM on July 31, 2018: member

Agree with @laanwj.
fanquake commented at 9:01 AM on August 2, 2018: member

Thanks @jsarenik, however looks like we are closing again.
fanquake closed this on Aug 2, 2018
jonasschnelli referenced this in commit d67f9d0db9 on Mar 15, 2019
PastaPastaPasta referenced this in commit c1beeb9ab4 on Jun 27, 2021
PastaPastaPasta referenced this in commit b17cb862a7 on Jun 28, 2021
PastaPastaPasta referenced this in commit 30bfb69e05 on Jun 29, 2021
PastaPastaPasta referenced this in commit 62d133dfbb on Jul 1, 2021
PastaPastaPasta referenced this in commit 4e1dbfb8dc on Jul 1, 2021
PastaPastaPasta referenced this in commit 1415a71188 on Jul 8, 2021
PastaPastaPasta referenced this in commit a4b2ac0c59 on Jul 10, 2021
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#11759 Docs: reflow the text and add better markup #15577 Docs: Enable TLS in link to chris.beams.io

Docs: reflow some markdown text files #13778

It's a matter of culture so take it easy. I appreciate a lot what is happening in bitcoin/bitcoin and wishing you all the best success!