github / github/markup

Include code files

Ouverte
#2,084 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Ruby
Étoiles
6k
Forks
3.4k
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

#1524

It would be great to have a way to include code files into README.rst. By separating the code to another file, we can do static type checking etc. on our examples to ensure they are always running correctly.

(I don't what the point of adding a stale bot is, if nobody triages the issues here...)

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by reading the referenced issue #1524 and the README.rst examples to determine the intended code-file inclusion behavior. Trace how README.rst is currently processed, then define and test a complete inclusion path whose behavior is clear for separated, statically checked examples.

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

Évaluation

Stack technique
ruby
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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