Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR tries to attempt a couple of issues at once:
SquidBuilder
struct as an alternative toOptions
. I believe thismakes the code more readable. For example instead of
Options
in favor ofSqidsBuilder
and removing it in the1.0
release.README.md
file as a crate-level doc-comment. This makes thedocs much more approachable since now the main doc page has actual useful
information instead of being a barren waste land. Since the
README.md
links to the
LICENSE
file I used a small hack to ensure that this link isstill valid.
README.md
file automatically turned the code examples intodocumentation tests. These were immediately broken because of missing imports
and error handling. I've added the necessary boilerplate. It's hidden by
rustdoc
but unfortunately looks a bit ugly when viewing theREADME.md
onGithub.
without docs. If I were maintainer of this crate, I'd turn this into a
deny
.Let me know if you want me to pull this apart into multiple PRs instead.