Programmiersprache: Rust 1.23 standardisiert die Dokumentation auf CommonMark

Die Programmiersprache Rust ebnet in Version 1.23 den Weg für die standardisierte Verwendung von CommonMark in der Rust-Dokumentation. Die ASCII-Funktionalität hält Einzug in einigen Typen und kann ohne zusätzlichen Code Verwendung finden.

In Pocket speichern vorlesen Druckansicht
Programmiersprache: Rust 1.23 standardisiert die Dokumentation mit CommonMark
Lesezeit: 2 Min.
Von
  • Björn Bohn

Mozillas Programmiersprache Rust, die vor allem auf Nebenläufigkeit und Praxisnähe ausgerichtet ist, bringt in der neuen Version 1.23 vor allem Änderungen für die Dokumentation mit sich. Außerdem hat sich die Stabilität der Rust-Bibliothek verbessert.

Das Rust-Dokumentation-Team hat entschieden, sich auf die Verwendung von CommonMark festzulegen. In vorherigen Rust-Versionen war nicht genau spezifiziert, welche Markdown-Rendering-Engine bei rustdoc zum Einsatz kam. Mit der Veröffentlichung von Rust 1.23 bietet die Dokumentation neben dem bisherigen Renderer Hoedown ebenfalls ein Rendern für CommonMark an und warnt den Benutzer vor eventuellen Unterschieden.

Das Rust-Team weist darauf hin, dass normalerweise Möglichkeiten bestehen, die Syntax so anzupassen, dass er sowohl unter Hoedown als auch CommonMark korrekt gerendert wird. In Zukunft soll Rust standardmäßig auf CommonMark setzen. Ein Blogpost des Teammitglieds Guillaume Gomez zeigt häufige Unterschiede auf und schlägt Lösungen vor, wie Entwickler diese beseitigen können.

In Rust 1.23 sind die Typen u8, char, [u8] und str standardmäßig mit ASCII-Funktionalität ausgestattet. In bisherigen Rust-Versionen war dafür noch die Implementierung des AsciiExt-Traits notwendig. Entwickler, die weiterhin ältere Rust-Versionen unterstützen wollen, können mit den Codezeilen

#[allow(unused_imports)]
use std::ascii::AsciiExt;

eine entsprechende Warnung unterdrücken. Sollen die älteren Versionen irgendwann nicht mehr erlaubt sein, können Entwickler die Zeilen einfach entfernen, ohne Funktionalität einzubüßen.

Eine detaillierte Liste der weiteren Veränderungen findet sich in den Release Notes. Wer sich intensiver mit der Programmiersprache auseinandersetzen will, sei auf GitHub verwiesen. (bbo)