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

Address questions regarding suitability for storage and untrusted inputs #346

Open
wants to merge 2 commits into
base: master
from

Conversation

@mbr
Copy link

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 #345, closes #216, addresses #240, #266.
@mbr
Copy link
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
Author

mbr commented Aug 14, 2020

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

Copy link
Collaborator

ZoeyR left a comment

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

configuration is used. This should ensure that later versions can still read
data produced by a previous versions of the library if no major version change
has occured. Beware that in the Rust ecosystem, for a `0.x` version, any change
in `x` is considered a **major** version change.

This comment has been minimized.

@ZoeyR

ZoeyR Aug 18, 2020

Collaborator

This last sentence is probably unnecessary since bincode is post 1.0

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

Successfully merging this pull request may close these issues.

3 participants
You can’t perform that action at this time.