Add --no-comment-extraction option#106
Open
Evian-Zhang wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Nowadays, Rustdoc supports to add comment from separate markdown files by
#![doc = include_str!("README.md")]As a result, it is great to combine this feature with cargo readme to eliminate the annoything
#lines for GitHub README readers (motivation can be seen here).The ideal workflow is:
User write a readme file
README.rustdoc.mdwhich is specific for rustdoc, and thelib.rswould include such readme file as documentation.In this file, code snippets are meant to be doc tested, and several
#are added to hide lines.Then, user would use
cargo readmeto process such file, and generate aREADME.mdfor the repository.In this README, lines hidden by
#are removed, and badges, licenses, etc. are added as template do.However, current
cargo readmecannot do this, since the file specified in--inputoption would still be treated as a Rust file, and the documentation would be extracted by matching the comment patterns. As a result, I add the--no-comment-extractionoption, which would treat input file as a plain markdown file, and no more extraction is needed.