search

timshannon / bolthold

BoltHold is an embeddable NoSQL store for Go types built on BoltDB
MIT License
648 stars 46 forks source link

Cleanup README + Fix s.Find Example #114

Closed wolveix closed 4 years ago

wolveix commented 4 years ago
coveralls commented 4 years ago

Coverage Status

Coverage remained the same at 87.027% when pulling 82952992c0219ee9c789c83e2cd4f5beff028144 on Wolveix:master into 0bc7c26a7c525b0d3d2b20c41ac0b72dd5f933bb on timshannon:master.

timshannon commented 4 years ago

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

wolveix commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

No worries. It's really not that big of a deal. :+1: