Issue 6 prepare crate for release #27
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The usage section includes showing what to add to the Cargo.toml file and an integration test to verify the version number is correct. This commit also includes setting the html_root_url attribute. See issue #6.
The usage example shows how to get started using the library. It is important that the example work as expected so the doc-comment crate is used to hook the example into Rust's document test system.
The formatting was failing rustfmt checks thus causing the build to fail. This commit fixes the formatting to make the build happy.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updating
Cargo.tomland the README in preparation of publishing the crate.