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

Aperta
#1,565 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
documentation

Direzione di ricerca

Inizia riproducendo il problema di rendering in RDoc con l’esempio rescue Exception, quindi esamina il modo in cui RDoc gestisce i backtick di Markdown. Confronta l’output generato con la documentazione di Timeout collegata e verifica che il codice inline composto da più parole venga renderizzato correttamente senza compromettere i casi esistenti di codice inline.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Ruby
Stelle
930
Fork
472
Merge medio
2g 8h
PR unite (30g)
12

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ruby/rdoc

Tutte le issue di ruby/rdoc

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.