Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Broken html when crossref matches `#<` without linking `<`

Geschlossen
  • Stimmt etwas nicht?
#1,743 0 Kommentare 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
58/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginne in lib/rdoc/markup/formatter.rb bei handle_regexp_CROSSREF und vergleiche es anhand des Beispiels im Issue mit RDoc::CrossReference::CROSSREF_REGEXP. Überprüfe, dass die generierte Dokumentation für Encoding::Converter keine fehlerhaften HTML mehr enthält, wenn ein Querverweis mit einem Leerzeichen beginnt, während die beabsichtigten Verweise weiterhin korrekt verlinkt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

https://docs.ruby-lang.org/en/4.0/Encoding/Converter.html#method-i-convpath

<p>In the above example, [#&lt;Encoding:ISO-8859-1&gt;,
 <encoding:utf-8&gt;] means="" a="" converter="" from="" iso-8859-1="" to="" utf-8.="" “crlf_newline”="" newline="" lf="" crlf.<="" p="">
 </encoding:utf-8&gt;]>
</p>

Second #<Encoding with a leading space is matched:

"In the above example, [#<Encoding:ISO-8859-1>, #<Encoding:UTF-8>] means"
  .match(RDoc::CrossReference::CROSSREF_REGEXP, 2)

# => #<MatchData " #<" 1:"#<" 2:nil 3:nil 4:nil 5:"<" 6:nil>

"<" doesn't get linked by handle_regexp_CROSSREF and assigns handled as unescaped text "<" which breaks html:

https://github.com/ruby/rdoc/blob/d6422f499fb2961b91de400f48426fc6d3fa5b67/lib/rdoc/markup/formatter.rb#L113-L115

Vorherrschende Sprache
Ruby
Sterne
928
Forks
470
Ø Merge
1 T. 10 Std.
Gemergte PRs (30 T.)
13

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.