Support multi-word backticks like `some code` in RDoc

Ouverte
#1,565 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
48/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
ruby
Domaine
documentation

Piste de recherche

Commencez par reproduire le problème de rendu dans RDoc avec l’exemple rescue Exception, puis examinez la manière dont RDoc gère les accents graves de Markdown. Comparez la sortie générée avec la documentation Timeout liée et vérifiez que le code inline composé de plusieurs mots est correctement rendu sans perturber les cas existants de code inline.

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

Description

From https://github.com/ruby/timeout/pull/92#discussion_r2699858272

With RDoc supporting more of Markdown, many will expect that

Here is `some code`

works.

But unfortunately it doesn't for e.g. rescue Exception:
Image
(from https://docs.ruby-lang.org/en/master/Timeout.html#method-c-timeout)

Somewhat related: https://github.com/ruby/rdoc/issues/1230

Langage dominant
Ruby
Étoiles
930
Forks
472
Merge moyen
2 j 8 h
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ruby/rdoc

Toutes les issues de ruby/rdoc

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

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