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

オープン
#1,565 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
ruby
領域
documentation

調査の方向性

まず、例 rescue Exception を使って RDoc でのレンダリング問題を再現し、次に RDoc が Markdown のバッククォートをどのように処理するかを調べます。生成された出力をリンク先の Timeout ドキュメントと比較し、複数の単語から成るインラインコードが既存のインラインコードのケースを壊すことなく正しくレンダリングされることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Ruby
スター
930
フォーク
472
平均マージ
2日 8時間
マージ済み PR(30日)
12

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ruby/rdoc のほかの issue

ruby/rdoc の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。