killercup / killercup/rust-docstrings

Get rid of Markdown writer

Ouverte
#6 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
help wanted
Langage dominant
Rust
Étoiles
12
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown, rust
Domaine
documentation
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.