killercup / killercup/rust-docstrings

Get rid of Markdown writer

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Rust
Stars
12
Forks
4
PR merge metrics
No merged PRs in 30d

Description

This crate contains an ad-hoc, incomplete, and probably also bug-ridden implementation of a Markdown _writer_: https://github.com/killercup/rust-docstrings/blob/aa705431de73da8bd59c4168148aedb77e020dd9/src/to_md.rs

I'd be great to upstream/outsource that.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading src/to_md.rs, the linked implementation, and the crate context around its Markdown writer. Investigate whether the writer can be upstreamed or replaced by an external implementation; done means the ad-hoc writer is no longer maintained in this crate and the chosen replacement is integrated.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, rust
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.