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

Update README example code #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ryanhatfield
Copy link

When opening this library in crates.io and then github, I found the README a bit cryptic, it left out actual usage of this crate.

This PR updates the example code to be fully valid rust code.

This can be tested by running cargo new test-crate and adding the contents of the README example to the main.rs file.

Changes to example code:

  • #![allow(unused)] to hide warnings
  • add dependencies used
  • wrap in main function
  • include same code as library example
  • order operations to read/write simple then advanced
  • output test file to validate results

Changes to example code:
* `#![allow(unused)]` to hide warnings
* add dependencies used
* wrap in main function
* include same code as library example
* order operations to read/write simple then advanced
* output test file to validate results
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.

1 participant