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

Offen
#1,565 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
48/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginne damit, das Darstellungsproblem in RDoc mit dem Beispiel rescue Exception zu reproduzieren, und untersuche anschließend, wie RDoc Markdown-Backticks verarbeitet. Vergleiche die erzeugte Ausgabe mit der verlinkten Timeout-Dokumentation und bestätige, dass mehrwortiger Inline-Code korrekt gerendert wird, ohne bestehende Fälle von Inline-Code zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Ruby
Sterne
930
Forks
472
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
12

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/rdoc

Alle Issues in ruby/rdoc

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.