Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Comments

Address questions regarding suitability for storage and untrusted inputs#346

Merged
3 commits merged intobincode-org:masterfrom
mbr:mbr/address-burning-questions-in-readme
Feb 23, 2021
Merged

Address questions regarding suitability for storage and untrusted inputs#346
3 commits merged intobincode-org:masterfrom
mbr:mbr/address-burning-questions-in-readme

Conversation

@mbr
Copy link
Contributor

@mbr mbr commented Aug 13, 2020

Puts some prominent text into the readme.md regarding some use cases
that are likely to be common, along with a few hopefully helpful
pointers to avoid footguns.

Closes #345, closes #216, addresses #240, #266.

Puts some prominent text into the `readme.md` regarding some use cases
that are likely to be common, along with a few hopefully helpful
pointers to avoid footguns.

Closes bincode-org#345, closes bincode-org#216, addresses bincode-org#240, bincode-org#266.
@mbr
Copy link
Contributor Author

mbr commented Aug 13, 2020

Please let me know if the style is fine; as the original readme.md is pleasantly terse. I did opt for putting it into the readme instead of the docs, as people evaluating a format will likely not dive into the docs straight away, but check readmes first.

@codecov-commenter
Copy link

codecov-commenter commented Aug 13, 2020

Codecov Report

Merging #346 into master will increase coverage by 2.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #346      +/-   ##
==========================================
+ Coverage   61.40%   63.47%   +2.06%     
==========================================
  Files          11       11              
  Lines         824      824              
==========================================
+ Hits          506      523      +17     
+ Misses        318      301      -17     
Impacted Files Coverage Δ
src/de/mod.rs 78.43% <0.00%> (+0.65%) ⬆️
src/ser/mod.rs 84.40% <0.00%> (+6.42%) ⬆️
src/config/limit.rs 54.54% <0.00%> (+9.09%) ⬆️
src/config/trailing.rs 71.42% <0.00%> (+14.28%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c393171...699069a. Read the comment docs.

@mbr
Copy link
Contributor Author

mbr commented Aug 14, 2020

Also, I have no idea why changing the readme.md supposedly affects code coverage ¯\(ツ)

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one minor nit. Otherwise everything looks good! Ignore the code coverage changes, rust is finicky about that.

@mbr
Copy link
Contributor Author

mbr commented Nov 16, 2020

Three months for a single sentence is not a terribly speedy response, but if this is still good to go, I've submitted the fix. Sorry, I only ran into this after hitting the "mark all read" button on my email account =(

@mbr mbr requested a review from a user November 16, 2020 18:36
@ghost
Copy link

ghost commented Feb 23, 2021

Three months to respond to such a fix is also quite slow on my part 😅

@ghost ghost merged commit 7b9fa8b into bincode-org:master Feb 23, 2021
@goral09
Copy link

goral09 commented Feb 23, 2021

Should I wait another three months to say "thank you"? ;)

@marc-casperlabs
Copy link

I'll skip the wait and say thanks right now. Much appreciated! :)

This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Please address suitability for untrusted inputs in docs Readme doesn't mention endian behavior

4 participants