Improve the docs when running cargo docs and fix the Clippy warnings for mdast_util_to_markdown

wooorm / markdown-rs

CommonMark compliant markdown parser in Rust with ASTs and extensions

https://docs.rs/markdown/1.0.0-alpha.21/markdown/

MIT License

965 stars 53 forks source link

Improve the docs when running cargo docs and fix the Clippy warnings for mdast_util_to_markdown #147

Closed bnchi closed 1 month ago

bnchi commented 1 month ago

This PR is a follow up for #127 to comply with how the docs are written in this project and to fix some of the warnings raised by Clippy when running cargo clippy --all-features --all-targets --workspace

bnchi commented 1 month ago

Screenshot 2024-10-07 at 16-09-45 Options in mdast_util_to_markdown - Rust

I believe this is the correct way to format the docs ?!

wooorm commented 1 month ago

Thanks!

I am currently locally looking through the code and refactoring such things! :)

bnchi commented 1 month ago

@wooorm

Sorry I've never worked on a lib before in Rust and I figured I messed up the docs in my initial PR.

Should I close this one then ?

wooorm commented 1 month ago

I think I had all of these in https://github.com/wooorm/markdown-rs/commit/e7ed52683a831f5a9fe4c692accf98f7bc9dd82c, thanks! :)

No worries, you do great work!