contributing.md: Fix formatting (line lengths and smart quotes) #8226

pull wbnns wants to merge 1 commits into bitcoin:master from wbnns:binns-contributing-formatting changing 1 files +109 −33

wbnns commented at 11:44 PM on June 19, 2016: none
This PR contains two commits onto CONTRIBUTING.md that:
1. Fix line line lengths. There were several instances where line lengths were well over 80 characters. This commit adjusts them to make them conform to formatting best practices, to stay under 80 characters when possible.
2. Adhere to consist use of quotes. There are a few instances where smart quotes are used (perhaps because it was pasted from a word processor). This commit replaces them with dumb quotes to keep it consistent with the quotation formatting found in the rest of the document.
jonasschnelli added the label Docs and Output on Jun 20, 2016
fanquake commented at 11:28 AM on June 22, 2016: member

Is there any rendered difference?

trivial ACK if it's felt this is worth merging, after it's squashed into a single commit.
MarcoFalke commented at 11:30 AM on June 22, 2016: member

@fanquake The rendered diff is https://github.com/bitcoin/bitcoin/pull/8226/files?short_path=6a33714#diff-6a3371457528722a734f3c51d9238c13
paveljanik commented at 2:50 PM on June 22, 2016: contributor

ACK after squash

contributing.md: Fix formatting

This commit contains two changes to CONTRIBUTING.md that:

Fix line line lengths. There were several instances where line lengths
were well over 80 characters. This commit adjusts them to make them
conform to formatting best practices, to stay under 80 characters when
possible.

Adhere to consist use of quotes. There are a few instances where smart
quotes are used (perhaps because it was pasted from a word processor).
This commit replaces them with dumb quotes to keep it consistent with
the quotation formatting found in the rest of the document.

be1d451225

wbnns commented at 2:42 PM on June 23, 2016: none

@fanquake @MarcoFalke @paveljanik Thank you all for the review. Squashed the changes into one commit as per your suggestions.
MarcoFalke commented at 3:18 PM on June 23, 2016: member

utACK https://github.com/bitcoin/bitcoin/pull/8226/files/be1d451225cc6d1e4bfe08ac7e67ad0780450f04?short_path=6a33714#diff-6a3371457528722a734f3c51d9238c13
paveljanik commented at 3:20 PM on June 23, 2016: contributor

ACK https://github.com/bitcoin/bitcoin/pull/8226/commits/be1d451225cc6d1e4bfe08ac7e67ad0780450f04
sipa commented at 2:56 PM on June 24, 2016: member

ACK be1d451225cc6d1e4bfe08ac7e67ad0780450f04, verified that the text does not change apart from smartquotes and whitespace.
laanwj commented at 11:43 AM on June 27, 2016: member

So "quoting" better than “quoting”? Isn't the latter usually preferable, unless when dealing with programming languages? I'm not convinced this is an improvement.
wbnns commented at 10:34 PM on June 27, 2016: none

@laanwj Hello, both are used in the document, so I chose the one that was more prevalent (dumb quotes) not only in the document, but in the codebase as well - I can switch all of them to one or the other, so they match in this file, however, my personal recommendation (for whatever it's worth 😀) would be to use dumb quotes, because it's easier to use on the command line, for example when grepping or just in general (much easier to use a regular dumb quotes key in the terminal as opposed to typing smart quotes in Emacs or Vim for example).

If you have a preference please let me know, or if you'd rather the document be left as-is I can revert the change.

Thank you sir, for the feedback and review!

Also, thanks Mr. @sipa!
sipa merged this on Aug 25, 2016
sipa closed this on Aug 25, 2016
sipa referenced this in commit 9d0f43b7ca on Aug 25, 2016
codablock referenced this in commit 66abe06cf8 on Sep 19, 2017
codablock referenced this in commit 85b1e9280e on Jan 9, 2018
codablock referenced this in commit 909945d34d on Jan 9, 2018
andvgal referenced this in commit c6f548b756 on Jan 6, 2019
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels