Skip to content

Fix for try_stream_replace_all in README - #167

Open
kaleidawave wants to merge 1 commit into
BurntSushi:masterfrom
kaleidawave:fix-issue-in-readme
Open

kaleidawave wants to merge 1 commit into
BurntSushi:masterfrom
kaleidawave:fix-issue-in-readme

Conversation

@kaleidawave

Copy link
Copy Markdown

I was trying this out and noticed that the reference to try_stream_replace_all in the README was missing the try_ and so was incorrect. I also noticed that the block had the ignore modifier on it and so was not getting run or compiled as a test.

This PR fixes the documentation and removed the ignore so that should not happen in the future.


I notice this crate is using the doc_comment crate and has a large multiline comment at the start of the lib.rs. I am wondering whether it would be a good separate change to remove this and use the #[doc = include_str!("../README.md")] feature which has been added since the creation of this crate?

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