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.

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

Cleanup README + Fix s.Find Example #114

Merged
merged 1 commit into from Jul 21, 2020
Merged

Cleanup README + Fix s.Find Example #114

merged 1 commit into from Jul 21, 2020

Conversation

wolveix
Copy link
Contributor

@wolveix wolveix commented Jul 21, 2020

@coveralls
Copy link

Coverage Status

Coverage remained the same at 87.027% when pulling 8295299 on Wolveix:master into 0bc7c26 on timshannon:master.

@timshannon timshannon merged commit 3be86da into timshannon:master Jul 21, 2020
@timshannon
Copy link
Owner

Not sure if I agree with removing all newlines on the markdown, but whatever. Thanks for the PR.

@wolveix
Copy link
Contributor Author

wolveix commented Jul 21, 2020

If not, then the changes didn't need to be merged. Just seems strange to have manual line breaks when most (if not all) clients support soft wrapping. Thanks for merging, though.

@cbrake
Copy link

cbrake commented Jul 21, 2020

for markdown, I typically instruct prettier to wrap long markdown lines with this option (I put it in .prettierrc)

proseWrap: always

This formats markdown like this:

https://raw.githubusercontent.com/simpleiot/simpleiot/master/README.md

This makes markdown nicer to read in an editor.

There are tradeoffs -- if the lines shift around, then diff's can be messier, but a super long one line paragraph does not diff very nice either.

@wolveix
Copy link
Contributor Author

wolveix commented Jul 21, 2020

That's true. I was just reading up on it and stumbled across GitLab's position on it. There are definitely pros and cons to both approaches.

@timshannon I meant no offense with removing them, it's just unusual to see and it caught my eye when I went to modify the s.Find example :) Please feel free to change them back, It's your project after all!

@timshannon
Copy link
Owner

No worries. It's really not that big of a deal. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants