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

Fix docify embed in md #28

Merged
merged 5 commits into from
Nov 4, 2024
Merged

Conversation

iulianbarbu
Copy link
Contributor

When embedding Rust code samples in markdown files, this happens with Rust lang. If the READMEs are included as crate level docs for example, those code samples will represent down the line doc tests.

We want ideally for docify::embed to have the same functionality when used for markdown files as it has for regular .rs docs.

This PR adds support for multiple langs, specifically for the case of wrapping around Rust code samples with rust,ignore, and avoid having them interpreted as docs tests.

Signed-off-by: Iulian Barbu <iulian.barbu@parity.io>
Signed-off-by: Iulian Barbu <iulian.barbu@parity.io>
Signed-off-by: Iulian Barbu <iulian.barbu@parity.io>
@iulianbarbu
Copy link
Contributor Author

iulianbarbu commented Nov 1, 2024

Hey @sam0x17 ! Can you take a look at this PR soonish and if all good merge/publish a new crate version for it? This fix is important for some workflows on polkadot-sdk where we want to ignore some rust docs tests, and I thought we might get it in and use it sometime next week, ideally by Wednesday when we'll have a release.

No problem at all if you can't, we have an ugly fix to use until this is released.

Signed-off-by: Iulian Barbu <iulian.barbu@parity.io>
@sam0x17
Copy link
Owner

sam0x17 commented Nov 2, 2024

fix test failures and then I can merge

@iulianbarbu
Copy link
Contributor Author

fix test failures and then I can merge

Thanks! Will do that soon.

Signed-off-by: Iulian Barbu <iulian.barbu@parity.io>
@iulianbarbu
Copy link
Contributor Author

@sam0x17, I think tests should pass now.

@sam0x17 sam0x17 merged commit aca7cc7 into sam0x17:main Nov 4, 2024
4 checks passed
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.

2 participants