Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Aug 25, 2016
Merged

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

merged 1 commit into from
Aug 25, 2016

Conversation

wbnns
Copy link

@wbnns wbnns commented Jun 19, 2016

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.

@fanquake
Copy link
Member

fanquake commented Jun 22, 2016 •
edited
Loading

Is there any rendered difference?

trivial ACK if it's felt this is worth merging, after it's squashed into a single commit.

@maflcko
Copy link
Member

maflcko commented Jun 22, 2016

@fanquake The rendered diff is https://github.com/bitcoin/bitcoin/pull/8226/files?short_path=6a33714#diff-6a3371457528722a734f3c51d9238c13

@paveljanik
Copy link
Contributor

ACK after squash

@wbnns
contributing.md: Fix formatting
be1d451 
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.
@wbnns
Copy link
Author

wbnns commented Jun 23, 2016

@fanquake @MarcoFalke @paveljanik Thank you all for the review. Squashed the changes into one commit as per your suggestions.

@maflcko
Copy link
Member

maflcko commented Jun 23, 2016

utACK https://github.com/bitcoin/bitcoin/pull/8226/files/be1d451225cc6d1e4bfe08ac7e67ad0780450f04?short_path=6a33714#diff-6a3371457528722a734f3c51d9238c13

@paveljanik
Copy link
Contributor

ACK be1d451

@sipa
Copy link
Member

sipa commented Jun 24, 2016

ACK be1d451, verified that the text does not change apart from smartquotes and whitespace.

@laanwj
Copy link
Member

laanwj commented Jun 27, 2016 •
edited
Loading

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
Copy link
Author

wbnns commented Jun 27, 2016 •
edited
Loading

@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 sipa merged commit be1d451 into bitcoin:master Aug 25, 2016
sipa added a commit that referenced this pull request Aug 25, 2016
@sipa
Merge #8226: contributing.md: Fix formatting (line lengths and smart …
9d0f43b 
…quotes)

be1d451 contributing.md: Fix formatting (Will Binns)
codablock pushed a commit to codablock/dash that referenced this pull request Jan 9, 2018
@sipa @codablock
Merge bitcoin#8226: contributing.md: Fix formatting (line lengths and…
85b1e92 
… smart quotes)

be1d451 contributing.md: Fix formatting (Will Binns)
codablock pushed a commit to codablock/dash that referenced this pull request Jan 9, 2018
@sipa @codablock
Merge bitcoin#8226: contributing.md: Fix formatting (line lengths and…
909945d 
… smart quotes)

be1d451 contributing.md: Fix formatting (Will Binns)
andvgal pushed a commit to energicryptocurrency/gen2-energi that referenced this pull request Jan 6, 2019
@sipa @andvgal
Merge bitcoin#8226: contributing.md: Fix formatting (line lengths and…
c6f548b 
… smart quotes)

be1d451 contributing.md: Fix formatting (Will Binns)
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@wbnns @fanquake @maflcko @paveljanik @sipa @laanwj @jonasschnelli